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

Request

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'

Response

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "xYZkjABcde",
      "type": "external_gateways",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde"
      },
      "attributes": {
        "name": "US payment gateway",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        },
        "authorize_url": "https://external_gateway.com/authorize",
        "capture_url": "https://external_gateway.com/capture",
        "void_url": "https://external_gateway.com/void",
        "refund_url": "https://external_gateway.com/refund",
        "token_url": "https://external_gateway.com/token",
        "shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c"
      },
      "relationships": {
        "payment_methods": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/relationships/payment_methods",
            "related": "https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/payment_methods"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/versions"
          }
        },
        "external_payments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/relationships/external_payments",
            "related": "https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/external_payments"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 external_gateways (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/external_gateways?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/external_gateways?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/external_gateways?page[number]=14&page[size]=10"
  }
}

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