Limiting the auto-capture amount

How to enable the auto-capture option only for orders under a certain amount

Problem

You have enabled the auto-capture option for a payment method, but you still want to require a manual capture for orders with a total amount over a specified threshold.

Solution

To add such a constraint, send a PATCH request to the /api/payment_methods/:id endpoint, using the auto_capture_max_amount_cents attribute value to set the amount over which you want the auto-capture option to be disabled.

Example

Request

The following request updates the payment method identified by the "hJGrTfdaEW " ID to automatically disable the auto capture for orders with a total amount over €2000:

curl -g -X PATCH \
  'http://yourdomain.commercelayer.io/api/payment_methods/hJGrTfdaEW' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "payment_methods",
    "id": "hJGrTfdaEW",
    "attributes": {
      "auto_capture": true,
      "auto_capture_max_amount_cents": 200000
    }
  }
}'

Response

More to read

See our documentation if you need more information on how to update a payment method.