COcommercelayer
checkout_com_gateways

Create a checkout.com gateway

Changed on

Create a checkout.com gateway

post/checkout_com_gateways

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/checkout_com_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"
      },
      "_check": true,
      "secret_key": "sk_test_xxxx-yyyy-zzzz",
      "public_key": "pk_test_xxxx-yyyy-zzzz"
    },
    "relationships": {
      "checkout_com_payments": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The created checkout.com 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

      added the new required request property ///

    • breaking

      request property / was restricted to a list of enum values

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • 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 checkout_com_gateways was removed

    • info

      added the new checkout_com_gateways enum value to the request property /

    • info

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