Update an external gateway

PATCH https://{{subdomain}}.commercelayer.io/api/external_gateways/{{external_gateway_id}}

Request Body

{"data"=>{"type"=>"external_gateways", "id"=>"{{external_gateway_id}}", "attributes"=>{"authorize_url"=>"{{external_gateway_authorize_url}}", "capture_url"=>"{{external_gateway_capture_url}}", "_reset_circuit"=>"{{external_gateway__reset_circuit}}"}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: OK

{"data":{"id":"xYZkjABcde","type":"external_gateways","links":{"self":"https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde"},"attributes":{"name":"US payment gateway","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"},"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","shared_secret":"1c0994cc4e996e8c6ee56a2198f66f3c"},"relationships":{"payment_methods":{"links":{"self":"https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/relationships/payment_methods","related":"https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/payment_methods"}},"versions":{"links":{"self":"https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/relationships/versions","related":"https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/versions"}},"external_payments":{"links":{"self":"https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/relationships/external_payments","related":"https://yourdomain.commercelayer.io/api/external_gateways/xYZkjABcde/external_payments"}}},"meta":{"mode":"test"}}}