PayPal payments can be created and associated with an order in a few steps:
Create a Paypal payment, passing a valid return_url
and cancel_url
Get the approval_url
from the response
Redirect the customer to the approval URL
Get the paypal_payer_id
from the return url parameters
Update the PayPal payment with the payer ID
PayPal payments are one-time payment sources and cannot be saved in customer wallets.
A paypal payment object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field | Type | Description |
type |
|
|
id |
| The paypal payment unique identifier |
links.self |
| The paypal payment endpoint URL |
attributes.return_url |
| The URL where the payer is redirected after they approve the payment. |
attributes.cancel_url |
| The URL where the payer is redirected after they cancel the payment. |
attributes.note_to_payer |
| A free-form field that you can use to send a note to the payer on PayPal. |
attributes.paypal_payer_id |
| The id of the payer that PayPal passes in the return_url. |
attributes.name |
| The PayPal payer id (if present) |
attributes.paypal_id |
| The id of the PayPal payment object. |
attributes.status |
| The PayPal payment status. One of 'created' (default) or 'approved'. |
attributes.approval_url |
| The URL the customer should be redirected to approve the payment. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.order |
| The order associated to the paypal payment, that is set as its payment source. |
relationships.payment_gateway |
| The associated payment gateway, inherited by the order payment_method. |
meta.mode |
| The resource environment (can be one of |