COcommercelayer
captures

Update a capture

Changed on

Update a capture

patch/captures/{captureId}

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/captures/{captureId}
  • Auth
    HTTP bearer

Path parameters

captureIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "_forward": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      },
      "_refund": true,
      "_refund_amount_cents": 500,
      "_cancel": true
    }
  }
}

Response

The updated capture object

Changes

  • e37b77a53fd0Revision changes
    • info

      added the optional property // to the response with the status

  • 859097ed3fe6Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property default value captures was removed

    • info

      added the new captures enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status