Update an external gateway

How to update an existing external gateway via API

To update an existing external gateway, send a PATCH request to the /api/external_gateways/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/external_gateways/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.name

string

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

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

attributes._reset_circuit

boolean

Optional

Example

The following request updates the external gateway identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "external_gateways",
    "id": "xYZkjABcde",
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    }
  }
}'

Last updated