COcommercelayer
checkout_com_gateways

Update a checkout.com gateway

Changed on

Update a checkout.com gateway

patch/checkout_com_gateways/{checkoutComGatewayId}

Request

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

Path parameters

checkoutComGatewayIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "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",
      "_update_webhooks": true,
      "_refresh_webhook_secrets": true
    },
    "relationships": {
      "checkout_com_payments": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The updated 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

  • 57ea5cf4622cRevision changes
    • info

      added the new optional request property //