Authorize Payout Transaction

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

accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

entryPoint

string | null

The entrypoint identifier.

Maximum length: 50

invoiceData

object[] | null

Array of bills associated to the transaction

invoiceData.AccountingField1

string | null

Optional custom field.

invoiceData.AccountingField2

string | null

Optional custom field.

invoiceData.AdditionalData

string | null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

invoiceData.attachments

object[] | null

Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly-accessible link. For full details on using this field with a payout authorization, see the documentation.

invoiceData.billId

integer | null

Bill ID in Payabli.

invoiceData.comments

string | null

Any comments about bill. For managed payouts, this field has a limit of 100 characters.

Maximum length: 250

invoiceData.dueDate

string | null

Bill due date in format YYYY-MM-DD or MM/DD/YYYY.

invoiceData.invoiceDate

string | null

Bill date in format YYYY-MM-DD or MM/DD/YYYY.

invoiceData.invoiceNumber

string | null

Custom number identifying the bill. Must be unique in paypoint. Required for new bill and when billId is not provided.

Maximum length: 250

invoiceData.netAmount

string | null

Net Amount owed in bill. Required when adding a bill.

invoiceData.Terms

string | null

Description of payment terms.

orderDescription

string | null

Text description of the transaction.

Maximum length: 250

orderId

string | null

Custom identifier for the transaction.

Maximum length: 250

paymentDetails

object

Object containing payment details.

paymentMethod

object

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

source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

subdomain

string | null

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

Maximum length: 50

subscriptionId

integer

Payabli identifier of the subscription associated with the transaction.

vendorData

object

Object containing vendor data.

vendorData.address1

string | null

required

Vendor's address

vendorData.city

string

required

Vendor's city.

vendorData.country

string

required

Vendor's country.

vendorData.ein

string

required

EIN/Tax ID for vendor.

vendorData.name1

string

required

Primary name for vendor. Required for new vendor.

vendorData.phone

string | null

required

Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.

vendorData.state

string

required

Vendor's state. Must be a 2 character state code.

vendorData.zip

string

required

Vendor's zip code.

vendorData.additionalData

object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

vendorData.address2

string | null

Additional line for vendor's address.

vendorData.billingData

object

Object containing vendor's bank information.

vendorData.contacts

object[] | null

Array of objects describing the vendor's contacts.

vendorData.customerVendorAccount

string | null

Account number of paypoint in the vendor side.

vendorData.customField1

string

vendorData.customField2

string

vendorData.email

string | null

Vendor's email address. Required for vCard.

vendorData.internalReferenceId

integer | null

Internal identifier for global vendor account.

vendorData.locationCode

string | null

Additional location code used to identify the vendor.

vendorData.mcc

string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

vendorData.name2

string | null

Secondary name for vendor.

vendorData.payeeName1

string | null

Alternative name used to receive paper check.

vendorData.payeeName2

string | null

Alternative name used to receive paper check.

vendorData.paymentMethod

object

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

vendorData.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

vendorData.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

vendorData.remitCity

string | null

Remittance address city. Used for mailing paper checks.

vendorData.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

vendorData.remitState

string | null

Remittance address state. Used for mailing paper checks.

vendorData.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

vendorData.vendorId

integer | null

Payabli identifier for vendor record. Required when vendorNumber isn't included.

vendorData.vendorNumber

string | null

Custom number identifying the vendor. Must be unique in paypoint.

vendorData.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Response

200 - application/json

isSuccess

boolean

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

pageIdentifier

string | null

Auxiliary validation used internally by payment pages and components.

responseData

object | null

The object containing the response data.

responseText

string | null

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

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Authorize Payout Transaction

Authorizations

Headers

Query Parameters

Body

Response