Release an authorized payment without capturing
Releases an authorized payment without taking any money; the whole hold returns to the payer and nothing settles.
/v1/payments/{paymentId}/voidReleases an authorized payment without taking any money; the whole hold returns to the payer and nothing settles. Requires payments:write and a merchant-side principal — a user token is refused insufficient_scope (403). Refuses payment_not_found (404) and invalid_state (409) when the payment is not awaiting capture.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08/void"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "requires_capture", "mode": "string", "payer_user_id": "295f0b28-ae85-4d57-93b3-e87e18f208b4", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "amount": 0, "captured_amount": 0, "refunded_amount": 0, "fee": 0, "commission": 0, "hold_expires_at": "2019-08-24T14:15:22Z", "line_items": [ { "name": "string", "amount": 0 } ], "created_at": "2019-08-24T14:15:22Z"}Capture an authorized payment, optionally partially
Captures an authorized payment. amount defaults to the full authorization; capturing less releases the remainder of the hold back to the payer in the same posting.
Refund a captured payment back to the payer's wallet
Returns captured money to the payer's wallet as a contra posting: the original transaction is never rewritten, so both movements stay in the history.