The identity and technical contract details declared by the specification.
AddPayoutSubscriptionResponse
object
Success response
4 properties
2 required
ContactsField
array
List of contacts.
AccountId
string
Custom identifier for payment connector.
Maskedaccount
string
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
BankName
string
Name of bank for account.
PayoutScheduleDetail
object
3 properties
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
Email
string
Email address.
Accountexp
string
Expiration date of card used in transaction.
CityNullable
string
The city.
RequestOutAuthorizeVendorData
object
Object containing vendor data.
32 properties
RemitEmail
string
Remittance email address. Used for sending virtual cards and other information about payouts.
PayeeName
string
Alternative name used to receive paper check.
Entrypointfield
string
The entrypoint identifier.
IdempotencyKey
string
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. Th…
Vendorid
integer
Payabli identifier for vendor record.
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
AchSecCode
string
Standard Entry Class (SEC) code is a three letter code that describes how an ACH payment was authorized. Supported values are: - PPD (Prearranged Payment and D…
CreatedAt
string
Timestamp of when record was created, in UTC.
BinData
object
Object containing information related to the card. This object is null unless the payment method is card. If the payment method is Apple Pay, the binData will…
11 properties
Holdername
string
The cardholder name.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
VendorPhone
string
Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.
AchHolderType
string
The bank's accountholder type: personal or business.
RequestOutAuthorizeVendorBillingData
object
Object containing vendor's bank information. This object is deprecated for this endpoint. Use the paymentMethod object in payout authorize requests instead.
5 properties
BillPayOutData
object
15 properties
2 required
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
Remitcountry
string
Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.
EnrollmentStatus
string
Enrollment status of vendor in payables program.
CustomerId
integer
The Payabli-generated unique ID for the customer.
InternalReferenceId
integer
An internal reference ID.
VendorName2
string
Secondary name for vendor. If provided, allowed characters are the same as the name1 field.
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
Comments
string
Any comment or description.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
PayoutSubscriptionRequestBody
object
10 properties
3 required
Vendorstatus
integer
Vendor's status. Allowed values: - 0 Inactive - 1 Active - -99 Deleted
BankAccountHolderType
string
Describes whether the bank is a personal or business account.
PaypointId
integer
The paypoint's ID. Note that this is different than the entryname.
PayoutPaymentDetail
object
Payment details for payout subscriptions.
13 properties
1 required
VendorPaymentMethod
object
Payment method object to use for the payout. - { method: "managed" } - Managed payment method - { method: "vcard" } - Virtual card payment method - { method: "…
2 properties
1 required
LocationCode
string
A location code used to identify the vendor's location.
PayoutSetPause
boolean
Flag indicating if the payout subscription is paused. When a payout subscription is paused, no payouts are processed until it's unpaused, and the next payment…
AdditionalDataString
string
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: json { "additionalData"…
RoutingAccount
string
Routing number of bank account.
VendorEin
string
EIN/Tax ID for vendor. Must be nine digits formatted as XX-XXXXXXX (for example, 12-3456789).
GeneralEvents
object
5 properties
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Ein
string
Business EIN or tax ID. This value is masked in API responses.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
BillingDataResponse
object
14 properties
13 required
UpdatePayoutSubscriptionBody
object
4 properties
BillPayOutDataRequest
object
12 properties
VendorQueryRecord
object
53 properties
VendorNumber
string
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
Remitzip
string
Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits o…
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
UpdatePayoutSubscriptionResponse
object
Success response
4 properties
1 required
BankAccountHolderName
string
The accountholder's name.
StoredMethodUsageType
string
Strongly recommended. The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to u…
ContactsResponse
object
4 properties
SplitFundingContent
object
4 properties
AdditionalDataMap
object
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](…
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. If you are using [custom identifiers](…
Storedmethodid
string
Payabli identifier of a tokenized payment method. If this field is used in a request, the method field is overridden and the payment is made using the payment…
Remitaddress2
string
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
Accounttype
string
Bank account type or card brand.
AccountingField
string
Optional custom field.
FileContentFtype
string
The MIME type of the file (if content is provided).
Mcc
string
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcccodes.csv) lists MCC codes.
Frequency
string
Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (s…
DeletePayoutSubscriptionResponse
object
Success response
3 properties
1 required
OrgParentId
integer
The ID of the org's parent organization.
QueryPaymentData
object
14 properties
VendorPaymentMethodString
string
The vendor's preferred payment method. Can be one of: - managed — Managed payment method - vcard — Virtual card payment method - check — Check payment method -…
LastModified
string
Timestamp of when record was last updated, in UTC.
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
PayoutSubscriptionQueryRecord
object
29 properties
4 required
AuthorizePaymentMethod
object
Payment method object for vendor payouts. - { method: "managed" } - Managed payment method - { method: "vcard" } - Virtual card payment method - { method: "che…
10 properties
1 required
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
Remitcity
string
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
NetAmountstring
string
Net amount owed in bill. Required when adding a bill.
Remitaddress1
string
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
Attachments
array
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Accountzip
string
ZIP code for card used in transaction.
Contacts
object
5 properties
Terms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30.
OrgParentName
string
The name of the parent organization.
Netamountnullable
number
Net amount.
EntrypageId
integer
If applicable, the internal reference ID to the payment page associated with the transaction.
VendorName1
string
Primary name for vendor. Required for new vendor.
StateNullable
string
The state or province.
PaymentCategories
object
4 properties
2 required
AddressNullable
string
The address.
SplitFunding
array
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
Remitstate
string
Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian…
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
VendorSummary
object
16 properties
Source
string
Custom identifier to indicate the transaction or request source.
Zip
string
ZIP code for address.
GetPayoutSubscriptionResponse
object
Success response
3 properties
1 required
TypeAccount
string
Type of bank account: Checking or Savings.
Orderdescription
string
Text description of the transaction.
PaymentDetail
object
Details about the payment.
8 properties
1 required
AccountNumber
string
Account number for bank account. This value is returned masked in responses.
Legalname
string
Business legal name.
AddressAddtlNullable
string
Additional line for the address.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Payabli publishes across the network.
