# 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.**\_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.**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.                                                                                                                                                                   |
| 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.**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. |
| relationships.**payment\_methods**     | `array`    | The associated payment methods.                                                                                                                                                                                                                 |
| relationships.**versions**             | `array`    | The associated changes.                                                                                                                                                                                                                         |
| 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`)                                                                                                                                                                                       |