The external gateway object

A comprehensive list of the external gateway resource's attributes and relationships

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

FieldTypeDescription

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.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.

relationships.payment_methods

array

The associated payment methods.

relationships.versions

array

The associated changes.

relationships.external_payments

array

The associated payments.

meta.mode

string

The resource environment (can be one of test or live)

Last updated