Skip to main content
POST
Void a payout instruction

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

voids a payout.

subMerchantId
string
required

Unique identifier of the submerchant that owns the payout. Required. If it is missing or does not match the payout, the request is rejected with HTTP 401 auth_invalid_submerchant.

payoutId
string
required

Unique identifier of the payout instruction to void. Required. Only a payout in pending status can be voided.

Response

200 - application/json

Successfuly voids a payout

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

code
string

Machine-readable result code. See the Error Codes reference.

message
string

Human-readable result message.