# The adyen gateway object

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

## Fields

| Field                                             | Type       | Description                                                                                                                                                                                         |
| ------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                          | `string`   | `adyen_gateways`                                                                                                                                                                                    |
| **id**                                            | `string`   | The adyen gateway unique identifier                                                                                                                                                                 |
| links.**self**                                    | `string`   | The adyen 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.**merchant\_account**                  | `string`   | The gateway merchant account.                                                                                                                                                                       |
| attributes.**api\_key**                           | `string`   | The gateway API key.                                                                                                                                                                                |
| attributes.**public\_key**                        | `string`   | The public key linked to your API credential.                                                                                                                                                       |
| attributes.**live\_url\_prefix**                  | `string`   | The prefix of the endpoint used for live transactions.                                                                                                                                              |
| attributes.**api\_version**                       | `integer`  | The checkout API version, supported range is from 66 to 71, default is 71.                                                                                                                          |
| attributes.**async\_api**                         | `boolean`  | Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version.                                                                                                |
| attributes.**partial\_payments**                  | `boolean`  | Send this attribute if you want to enable partial payments for the order.                                                                                                                           |
| attributes.**order\_expiration\_mins**            | `integer`  | The minutes after which the order created for partial payments automatically expires.                                                                                                               |
| attributes.**native\_customer\_payment\_sources** | `boolean`  | Indicates if the gateway will use the native customer payment sources.                                                                                                                              |
| attributes.**webhook\_endpoint\_secret**          | `string`   | The gateway webhook endpoint secret, generated by Adyen customer area.                                                                                                                              |
| attributes.**webhook\_endpoint\_url**             | `string`   | The gateway webhook URL, generated automatically.                                                                                                                                                   |
| relationships.**payment\_methods**                | `array`    | The associated payment methods.                                                                                                                                                                     |
| relationships.**versions**                        | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**                   | `array`    | The associated event stores.                                                                                                                                                                        |
| relationships.**adyen\_payments**                 | `array`    | The associated payments.                                                                                                                                                                            |
| meta.**mode**                                     | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |