COcommercelayer
external_gateways

Create an external gateway

Changed on

Create an external gateway

post/external_gateways

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/external_gateways
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "US payment gateway",
      "force_payments": true,
      "idempotency_window_mins": 60,
      "_disable": true,
      "_enable": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      },
      "external_includes": [
        "order.line_item_options"
      ],
      "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"
    }
  }
}

Response

The created external gateway object

Changes

  • 71dbd5f83326Revision changes
    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

  • 859097ed3fe6Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property default value external_gateways was removed

    • info

      added the new external_gateways enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status