Create an external gateway

How to create an external gateway via API

To create a new external gateway, send a POST request to the /api/external_gateways endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/external_gateways

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.force_payments	boolean	Optional, default is 'false'
attributes._disable	boolean	Optional
attributes._enable	boolean	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
attributes.external_includes	array	Optional, default to resource specific list
attributes.authorize_url	string	Optional
attributes.capture_url	string	Optional
attributes.void_url	string	Optional
attributes.refund_url	string	Optional
attributes.token_url	string	Optional

Example

Request

The following request creates a new external gateway:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/external_gateways' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "external_gateways",
    "attributes": {
      "name": "US payment gateway"
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "XAyRWNUzyN",
    "type": "external_gateways",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/external_gateways/XAyRWNUzyN"
    },
    "attributes": {
      "name": "US payment gateway",
      "force_payments": true,
      "credential_keys": {
        "api_key": "********BW989"
      },
      "disabled_at": "2018-01-01T12:00:00.000Z",
      "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"
      },
      "circuit_state": "closed",
      "circuit_failure_count": 5,
      "shared_secret": "1c0994cc4e996e8c6ee56a2198f66f3c",
      "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"
    },
    "relationships": {
      "payment_methods": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_gateways/XAyRWNUzyN/relationships/payment_methods",
          "related": "https://yourdomain.commercelayer.io/api/external_gateways/XAyRWNUzyN/payment_methods"
        }
      },
      "event_stores": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_gateways/XAyRWNUzyN/relationships/event_stores",
          "related": "https://yourdomain.commercelayer.io/api/external_gateways/XAyRWNUzyN/event_stores"
        }
      },
      "external_payments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/external_gateways/XAyRWNUzyN/relationships/external_payments",
          "related": "https://yourdomain.commercelayer.io/api/external_gateways/XAyRWNUzyN/external_payments"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  },
  "meta": {
    "mode": "test",
    "organization_id": "xRRkjDFafe",
    "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
  }
}