v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB

Capture Endpoints

Create capture

Capture all or part of an authorization on a payment charge.

post/v1/payment-charges/{paymentChargeId}/captures

paymentChargeIdstring required

Merchant-Idstring required

The merchant identifier.

Request-Referencestring

Unique request reference to facilitate debugging.

Request-Idempotency-Keystring

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

merchantCaptureReferencestring

The merchant provided capture reference.

amountinteger required

The capture amount in the payment charge currency's smallest unit.

labelsobject

Custom labels associated with the capture.

{
  "merchantCaptureReference": "5c019979-0751-469e-96e0-b67f1d95c577",
  "amount": 1000
}