> 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/external_gateways/object.md). # The external gateway object An external gateway object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/external_gateways` endpoint. ## Fields | Field | Type | Description | | ------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | `string` | `external_gateways` | | **id** | `string` | The external gateway unique identifier | | links.**self** | `string` | The external 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.**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.**circuit\_state** | `string` | The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made. | | attributes.**circuit\_failure\_count** | `integer` | The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. | | attributes.**\_reset\_circuit** | `boolean` | Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. | | attributes.**shared\_secret** | `string` | The shared secret used to sign the external request payload. | | attributes.**\_regenerate\_shared\_secret** | `boolean` | Send this attribute if you want to regenerate the shared secret. | | attributes.**external\_includes** | `array` | List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided. | | attributes.**authorize\_url** | `string` | The endpoint used by the external gateway to authorize payments. | | attributes.**capture\_url** | `string` | The endpoint used by the external gateway to capture payments. | | attributes.**void\_url** | `string` | The endpoint used by the external gateway to void payments. | | attributes.**refund\_url** | `string` | The endpoint used by the external gateway to refund payments. | | attributes.**token\_url** | `string` | The endpoint used by the external gateway to create a customer payment token. | | relationships.**payment\_methods** | `array` | The associated payment methods. | | relationships.**event\_stores** | `array` | The associated event stores. | | relationships.**external\_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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.commercelayer.io/core-api-reference/external_gateways/object.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.