# The paypal payment object

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**                           | `string`  | `paypal_payments`                                                                                                                                                                                   |
| **id**                             | `string`  | The paypal payment unique identifier                                                                                                                                                                |
| links.**self**                     | `string`  | The paypal payment endpoint URL                                                                                                                                                                     |
| attributes.**return\_url**         | `string`  | The URL where the payer is redirected after they approve the payment.                                                                                                                               |
| attributes.**cancel\_url**         | `string`  | The URL where the payer is redirected after they cancel the payment.                                                                                                                                |
| attributes.**note\_to\_payer**     | `string`  | A free-form field that you can use to send a note to the payer on PayPal.                                                                                                                           |
| attributes.**paypal\_payer\_id**   | `string`  | The id of the payer that PayPal passes in the return\_url.                                                                                                                                          |
| attributes.**name**                | `string`  | The PayPal payer id (if present).                                                                                                                                                                   |
| attributes.**paypal\_id**          | `string`  | The id of the PayPal payment object.                                                                                                                                                                |
| attributes.**status**              | `string`  | The PayPal payment status. One of 'created', or 'approved'.                                                                                                                                         |
| attributes.**approval\_url**       | `string`  | The URL the customer should be redirected to approve the payment.                                                                                                                                   |
| attributes.**mismatched\_amounts** | `boolean` | Indicates if the order current amount differs form the one of the created payment intent.                                                                                                           |
| attributes.**payment\_instrument** | `object`  | Information about the payment instrument used in the transaction.                                                                                                                                   |
| attributes.**created\_at**         | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**         | `string`  | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**           | `string`  | 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**   | `string`  | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**            | `object`  | 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**            | `object`  | The order associated to the PayPal payment, that is set as its payment source.                                                                                                                      |
| relationships.**payment\_gateway** | `object`  | The associated payment gateway, inherited by the order payment\_method.                                                                                                                             |
| relationships.**event\_stores**    | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                      | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.commercelayer.io/core-api-reference/paypal_payments/object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.