v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB

Void Endpoints

Create void

Void all or part of an authorization on a payment charge that has not yet been captured.

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

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.

merchantVoidReferencestring

The merchant provided void reference.

amountinteger required

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

labelsobject

Custom labels associated with the void.

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