Update a capture

How to update an existing capture via API

To update an existing capture, send a PATCH request to the /api/captures/: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/captures/:id

Arguments

Body ParameterTypeRequired

type

string

Required

id

string

Required

attributes.succeeded

boolean

Optional

attributes._forward

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

attributes._refund

boolean

Optional

attributes._refund_amount_cents

integer

Optional

Example

The following request updates the capture identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/captures/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "captures",
    "id": "xYZkjABcde",
    "attributes": {
      "_refund": true,
      "_refund_amount_cents": 500
    }
  }
}'

Last updated