List all external gateways
How to fetch a collection of external gateways via API
To fetch a collection of external gateways, send a GET
request to the /api/external_gateways
endpoint.
Request
GET https://yourdomain.commercelayer.io/api/external_gateways
Example
The following request fetches a collection of external gateways:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/external_gateways/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of external gateways can be sorted by the following fields:
Attributes
name
id
created_at
updated_at
reference
reference_origin
circuit_state
circuit_failure_count
Filterable fields
The list of external gateways can be filtered by the following fields:
Attributes
name
id
created_at
updated_at
reference
reference_origin
metadata
circuit_state
circuit_failure_count
Relationships
payment_methods
external_payments
Last updated