APIPay 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 isn’t generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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 won’t 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.
paymentMethodobjectRequired
Payment method object for vendor payouts. - `{ method: "managed" }` - Managed payment method - `{ method: "vcard" }` - Virtual card payment method - `{ method: "check" }` - Check payment method - `{ method: "ach", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." }` - ACH payment method with bank details - `{ method: "ach", storedMethodId: "..." }` - ACH payment method using stored method ID
paymentDetailsobjectRequired
Object containing payment details.
vendorDataobjectRequired
Object containing vendor data.
invoiceDatalist of objectsRequired
Array of bills associated to the transaction
sourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.
orderIdstringOptional<=250 characters
Custom identifier for the transaction.
orderDescriptionstringOptional<=250 characters
Text description of the transaction.
accountIdstringOptional<=250 characters
Custom identifier for payment connector.
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
responseCodeinteger

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

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

Field not in use on this endpoint. It always returns 0.

isSuccessboolean

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

responseTextstring

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

responseDataobject

Errors