Capture payout

Captures a single authorized payout transaction by ID.

Path parameters

referenceIdstringRequired

The ID for the payout transaction.

Headers

requestTokenstringRequired
idempotencyKeystringOptional

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Response

Success

isSuccessbooleanOptional

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

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseDataobjectOptional
responseTextstringOptional

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

Errors