Capture list of payouts

Captures an array of authorized payout transactions for settlement.

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.

Request

Array of identifiers of payout transactions to capture.

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.
responseCodeinteger or null

Code for the response. Learn more in API Response Codes.

responseDatalist of objects or null
Array of objects describing the transactions.
responseTextstring or null

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

Errors