# The paypal gateway object

A paypal gateway object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/paypal_gateways` endpoint.

## Fields

| Field                              | Type       | Description                                                                                                                                                                                         |
| ---------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                           | `string`   | `paypal_gateways`                                                                                                                                                                                   |
| **id**                             | `string`   | The paypal gateway unique identifier                                                                                                                                                                |
| links.**self**                     | `string`   | The paypal gateway endpoint URL                                                                                                                                                                     |
| attributes.**name**                | `string`   | The payment gateway's internal name.                                                                                                                                                                |
| attributes.**force\_payments**     | `boolean`  | Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.                                                                                 |
| attributes.**\_disable**           | `boolean`  | Send this attribute if you want to mark this resource as disabled.                                                                                                                                  |
| attributes.**\_enable**            | `boolean`  | Send this attribute if you want to mark this resource as enabled.                                                                                                                                   |
| attributes.**disabled\_at**        | `datetime` | Time at which this resource was disabled.                                                                                                                                                           |
| attributes.**created\_at**         | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**         | `datetime` | 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.                                        |
| attributes.**client\_id**          | `string`   | The gateway client ID.                                                                                                                                                                              |
| attributes.**client\_secret**      | `string`   | The gateway client secret.                                                                                                                                                                          |
| relationships.**payment\_methods** | `array`    | The associated payment methods.                                                                                                                                                                     |
| relationships.**versions**         | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**    | `array`    | The associated event stores.                                                                                                                                                                        |
| relationships.**paypal\_payments** | `array`    | The associated payments.                                                                                                                                                                            |
| 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_gateways/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.