POST
/
MoneyOut
/
authorize

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

idempotencyKey
string

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

forceCustomerCreation
boolean
default:
false

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.

allowDuplicatedBills
boolean
default:
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.

doNotCreateBills
boolean
default:
false

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

Body

entryPoint
string | null

The entrypoint identifier.

Maximum length: 50
subdomain
string | null

Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.

Maximum length: 50
source
string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100
accountId
string | null

Custom identifier for payment connector.

Maximum length: 250
orderId
string | null

Custom identifier for the transaction.

Maximum length: 250
orderDescription
string | null

Text description of the transaction.

Maximum length: 250
subscriptionId
integer

Payabli identifier of the subscription associated with the transaction.

paymentMethod
object

Object containing details about the payment method to use for the payout.

paymentDetails
object

Object containing payment details.

vendorData
object

Object containing vendor data.

invoiceData
object[] | null

Array of bills associated to the transaction

Response

200 - application/json
isSuccess
boolean

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

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

responseData
object | null

The object containing the response data.