Skip to main content
A payment records the outcome of a charge and any subsequent voids or refunds.

Payments are immediate sales

POST /payments charges the card immediately. The request field capture defaults to "sale", and the response reports it back as captureMode: "sale".
Authorize now, capture later is not supported. capture: "auth" and POST /payments/{id}/capture return 501 CAPTURE_NOT_SUPPORTED.

Status reference

State diagram

Settlement and batches

A batch is a group of transactions the payment processor submits for settlement. Settlement is the process of transferring funds for those transactions. Whether a payment has settled determines whether it can be voided or requires a refund.

Void or refund

POST /payments/{id}/void cancels the payment before its batch settles, including the principal and any separately charged service fee. The principal is the payment amount excluding the service fee.If the gateway rejects the void because the batch has settled, the API returns 422 VOID_FAILED with details.suggestedAction: "refund". The void endpoint does not issue a refund automatically.POST /payments/{id}/refund reverses a payment. If the payment has not settled, the API voids it instead. The response identifies the operation in reversalType, which is "void" or "refund".Use the void endpoint when you want cancellation to fail if a void is unavailable. Use the refund endpoint to let the API select the reversal operation.
See Refunds for partial refunds and service-fee handling. The exact request and response schemas are in the API Reference tab.