The paypal payment object
A comprehensive list of the paypal payment resource's attributes and relationships
A paypal payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/paypal_payments
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The paypal payment unique identifier |
links.self |
| The paypal payment endpoint URL |
attributes.approval_url |
| The URL the customer should be redirected to approve the payment. |
attributes.cancel_url |
| The URL where the payer is redirected after they cancel the payment. |
attributes.created_at |
| Time at which the resource was created. |
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. |
attributes.mismatched_amounts |
| Indicates if the order current amount differs form the one of the created payment intent. |
attributes.name |
| The PayPal payer id (if present). |
attributes.note_to_payer |
| A free-form field that you can use to send a note to the payer on PayPal. |
attributes.payment_instrument |
| Information about the payment instrument used in the transaction. |
attributes.paypal_id |
| The id of the PayPal payment object. |
attributes.paypal_payer_id |
| The id of the payer that PayPal passes in the return_url. |
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.return_url |
| The URL where the payer is redirected after they approve the payment. |
attributes.status |
| The PayPal payment status. One of 'created', or 'approved'. |
attributes.updated_at |
| Time at which the resource was last updated. |
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. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated