Update an external payment
PATCH https://{{subdomain}}.commercelayer.io/api/external_payments/{{external_payment_id}}
Request Body
{"data"=>{"type"=>"external_payments", "id"=>"{{external_payment_id}}", "attributes"=>{"options"=>"{{external_payment_options}}", "reference"=>"{{external_payment_reference}}", "metadata"=>"{{external_payment_metadata}}"}, "relationships"=>{"order"=>{"data"=>{"type"=>"orders", "id"=>"{{external_payment_rel_id}}"}}}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Authorization | string |
RESPONSES
status: OK
{"data":{"id":"xYZkjABcde","type":"external_payments","links":{"self":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde"},"attributes":{"payment_source_token":"xxxx.yyyy.zzzz","options":{"foo":"bar"},"payment_instrument":{"issuer":"cl bank","card_type":"visa"},"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"}},"relationships":{"order":{"links":{"self":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/relationships/order","related":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/order"}},"payment_gateway":{"links":{"self":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/relationships/payment_gateway","related":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/payment_gateway"}},"wallet":{"links":{"self":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/relationships/wallet","related":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/wallet"}},"versions":{"links":{"self":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/relationships/versions","related":"https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/versions"}}},"meta":{"mode":"test"}}}