> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/adyen_gateways/object.md). # The adyen gateway object A comprehensive list of the adyen gateway resource's attributes and relationships 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.**idempotency\_window\_mins** | `integer` | The minutes within which a repeated payment operation is deduplicated by the gateway idempotency key. Later attempts get a fresh key. | | attributes.**credential\_keys** | `object` | The payment gateway's API credential keys last digits. | | 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** | `string` | Time at which this resource was disabled. | | 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. | | attributes.**\_check** | `boolean` | Send this attribute if you want to check the credentials against the payment gateway's APIs. | | 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. When omitted, the webhook and its secret are generated automatically, provided the API key has the Management API webhooks read and write role. | | attributes.**token\_webhook\_endpoint\_secret** | `string` | The gateway tokenization webhook endpoint secret, generated by Adyen customer area. | | attributes.**webhook\_endpoint\_id** | `string` | The gateway webhook ID, generated automatically. | | attributes.**webhook\_endpoint\_url** | `string` | The gateway webhook URL, generated automatically. | | attributes.**\_update\_webhooks** | `boolean` | Send this attribute if you want to create or sync the gateway webhook, adopting any webhook already pointing to the gateway URL, and refresh its secret. | | attributes.**\_refresh\_webhook\_secrets** | `boolean` | Send this attribute if you want to refresh the gateway webhook endpoint secret. | | relationships.**payment\_methods** | `array` | The associated payment methods. | | 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`) | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.commercelayer.io/core-api-reference/adyen_gateways/object.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.