Capture payout

Captures a single authorized payout transaction by ID.

Path parameters

referenceIdstringRequired
The ID for the payout transaction.

Headers

requestTokenstringRequired
idempotencyKeystringOptional

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn’t generated in Payabli, you must generate it yourself.

Response

Success
isSuccessboolean or null

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
responseDataobject or null
responseTextstring or null

Response text for operation: ‘Success’ or ‘Declined’.

Errors