API referencePay Out endpointsPayouts

Authorize payout

Authorizes transaction for payout. Authorized transactions aren’t flagged for settlement until captured. Use referenceId returned in the response to capture the transaction.

Authentication

requestTokenstring
API Key authentication via header

Headers

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 is not generated in Payabli, you must generate it yourself.

Query Parameters

allowDuplicatedBillsbooleanOptionalDefaults to false

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.

doNotCreateBillsbooleanOptionalDefaults to false

When true, Payabli will not automatically create a bill for this payout transaction.

forceVendorCreationbooleanOptionalDefaults to false

When true, the request creates a new vendor record, regardless of whether the vendor already exists.

Request

This endpoint expects an object.
entryPointstringRequired<=50 characters
The entrypoint identifier.
paymentDetailsobjectRequired
Object containing payment details.
vendorDataobjectRequired
Object containing vendor data.
accountIdstringOptional<=250 characters
Custom identifier for payment connector.
invoiceDatalist of objectsOptional
Array of bills associated to the transaction
orderDescriptionstringOptional<=250 characters
Text description of the transaction.
orderIdstringOptional<=250 characters
Custom identifier for the transaction.
paymentMethodobjectOptional
Object containing details about the payment method to use for the payout.
sourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.
subdomainstringOptional<=50 characters
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
subscriptionIdlongOptional
Payabli identifier of the subscription associated with the transaction.

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