Authorize Payout Transaction
Authorizes transaction for payout. Authorized transactions aren’t flagged for settlement until captured. Use referenceId
returned in the response to capture the transaction.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Headers
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.
Query Parameters
When true
, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.
When true
, the authorization bypasses the requirement for unique bills, identified by vendor invoice number. This allows you to make more than one payout authorization for a bill, like a split payment.
When true
, Payabli will not automatically create a bill for this payout transaction.
Body
The entrypoint identifier.
50
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
50
Custom identifier to indicate the transaction or request source.
100
Custom identifier for payment connector.
250
Custom identifier for the transaction.
250
Text description of the transaction.
250
Payabli identifier of the subscription associated with the transaction.
Object containing details about the payment method to use for the payout.
Object containing payment details.
Object containing vendor data.
Array of bills associated to the transaction
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
Response text for operation: 'Success' or 'Declined'.
Auxiliary validation used internally by payment pages and components.
The object containing the response data.
Was this page helpful?