Update an external payment
How to update an existing external payment via API
To update an existing external payment, send a PATCH
request to the /api/external_payments/: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_payments/:id
Arguments
Body Parameter | Type | Required |
---|---|---|
type |
| Required |
id |
| Required |
attributes.options |
| Optional |
attributes.reference |
| Optional |
attributes.reference_origin |
| Optional |
attributes.metadata |
| Optional |
relationships.order |
| Optional |
Example
The following request updates the external payment identified by the ID "xYZkjABcde":
Last updated