The identity and technical contract details declared by the specification.
AccountId
string
Custom identifier for payment connector.
Shippingaddress
string
The shipping address.
FreightAmount
number
Freight/shipping amount.
RequestSchedulePaymentMethodInitiator
object
The required and recommended fields for a payment made with a stored payment method.
3 properties
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).
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
BillDataPaymentTerms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30. Mirrors the values in [Terms](schema-terms).
Email
string
Email address.
Accountexp
string
Expiration date of card used in transaction.
BillingStateNullable
string
Billing state. Must be a 2-letter state code for addresses in the US.
BillingCountryNullable
string
Billing address country.
Cardzip
string
ZIP or postal code for the billing address of cardholder. We strongly recommend that you include this field when using card as a method.
CustomerStatus
integer
Customer Status. Possible values: - -99 Deleted - 0 Inactive - 1 Active - 85 Locked (typically due to multiple failed login attempts)
PayMethodACH
object
8 properties
4 required
SummaryCommodityCode
string
Commodity code.
ItemUnitofMeasure
string
Unit of measurement. Max length of 100 characters.
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…
AddSubscriptionResponse
object
Success response
4 properties
2 required
QueryTransactionPayorData
object
22 properties
DutyAmount
number
Duty amount.
Tax
number
Tax rate in percent applied to the invoice.
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…
ItemDescription
string
Item or product description. Max length of 250 characters.
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'.
AchHolderType
string
The bank's accountholder type: personal or business.
Cardnumber
string
The card number. Required when method is card and a storedMethodId isn't included.
Shippingstate
string
Shipping state or province.
RequestUpdateSchedule
object
3 properties
RequestSchedulePaymentMethod
Information about the payment method for the transaction. Required and recommended fields for each payment method type are described in each schema below.
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
CustomerId
integer
The Payabli-generated unique ID for the customer.
BillingCityNullable
string
Billing city.
CustomerNumberNullable
string
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
BillItem
object
12 properties
BillingAddressAddtlNullable
string
Additional line for the billing address.
ItemProductCode
string
Item or product code. Max length of 250 characters.
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
Achaccounttype
string
Bank account type: Checking or Savings.
BillData
object
32 properties
PaypointId
integer
The paypoint's ID. Note that this is different than the entryname.
SubscriptionQueryRecords
object
31 properties
5 required
PayMethodCredit
object
8 properties
3 required
TermsConditions
string
Custom terms and conditions included in the invoice.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
GeneralEvents
object
5 properties
BillingAddressNullable
string
Billing address.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
Cardexp
string
Card expiration date in format MMYY or MM/YY. Required for card transactions.
Shippingcountry
string
Shipping address country.
SaveIfSuccess
boolean
When true, Payabli saves the payment method if the transaction is successful. The payment method ID is returned in the response as methodReferenceId. Defaults…
Device
string
Identifier of registered cloud device used in the transaction.
SetPause
boolean
Flag indicating if subscription is paused. When a subscription is paused, no payments are processed until the subscription is unpaused, and the next payment da…
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
Cardcvv
string
Card Verification Value (CVV) associated with the card number. We strongly recommend that you include this field when using card as a method.
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…
ForceCustomerCreation
boolean
When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false.
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](…
SubscriptionRequestBody
object
10 properties
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…
Accounttype
string
Bank account type or card brand.
SubscriptionType
string
Subscription type or category. Can't be changed after the subscription is created; if sent to the update endpoint, it's ignored. - Regular: A standard recurrin…
Shippingcity
string
Shipping city.
ScheduleDetail
object
4 properties
FileContentFtype
string
The MIME type of the file (if content is provided).
Frequency
string
Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (s…
QueryPaymentData
object
14 properties
LastModified
string
Timestamp of when record was last updated, in UTC.
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
Shippingaddressadditional
string
Additional line for shipping address.
ShippingFromZip
string
Sender shipping ZIP code.
Invoicestatus
integer
Invoice status code.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
AchHolder
string
Bank account holder. This field is required when method is ach or check.
Achaccount
string
Bank account number.
ItemCommodityCode
string
Item or product commodity code. Max length of 250 characters.
Cardholder
string
Cardholder name.
ItemProductName
string
Item or product name. Max length of 250 characters.
Attachments
array
Array of fileContent objects with attached documents. Max upload size is 30 MB.
RemoveSubscriptionResponse
object
Success response
3 properties
1 required
Accountzip
string
ZIP code for card used in transaction.
PayorDataRequest
object
Customer information. May be required, depending on the paypoint's settings. Required for subscriptions.
21 properties
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.
BillingZip
string
Billing address ZIP code.
Achrouting
string
ABA/routing number of Bank account.
PaymentCategories
object
4 properties
2 required
Shippingzip
string
Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: 37615-1234 or 3…
SplitFunding
array
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
PhoneNumber
string
Phone number.
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
InvoiceAmount
number
The invoice amount.
Source
string
Custom identifier to indicate the transaction or request source.
InvoiceType
integer
Invoice type. Value 0 is for single/one-time invoices, 1 for scheduled invoices.
Orderdescription
string
Text description of the transaction.
PurchaseOrder
string
Purchase order number.
Identifierfields
array
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
PaymentDetail
object
Details about the payment.
8 properties
1 required
UpdateSubscriptionResponse
object
Success response
4 properties
1 required
Legalname
string
Business legal name.
Discount
number
Discount applied to the invoice.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Payabli publishes across the network.
