The identity and technical contract details declared by the specification.
AccountId
string
Custom identifier for payment connector.
Shippingaddress
string
The shipping address.
AvsResponse
string
Text code describing the result for address validation (applies only for card transactions).
FreightAmount
number
Freight/shipping amount.
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).
ResponseChargeBack
object
4 properties
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
CvvResponseText
string
Text code describing the result for CVV validation (applies only for card transactions).
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.
SplitCount
integer
Number of split funding instructions associated with the transaction. Returns 0 when the transaction has no splits.
CvvResponse
string
Text code describing the result for CVV validation (applies only for card transactions).
ResultCodeText
string
Description of the result code. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
Discount
number
Discount applied to the invoice.
CustomerStatus
integer
Customer Status. Possible values: - -99 Deleted - 0 Inactive - 1 Active - 85 Locked (typically due to multiple failed login attempts)
ItemUnitofMeasure
string
Unit of measurement. Max length of 100 characters.
SummaryCommodityCode
string
Commodity code.
TransactionTime
string
Timestamp when transaction was submitted, in UTC.
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…
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
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.
Shippingstate
string
Shipping state or province.
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
FeeAmount
number
Service fee or sub-charge applied.
CustomerId
integer
The Payabli-generated unique ID for the customer.
ExternalProcessorInformation
string
Information from the external processor about the transaction.
CustomerNumberNullable
string
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
BillItem
object
12 properties
ItemProductCode
string
Item or product code. Max length of 250 characters.
TransactionQueryRecords
object
40 properties
2 required
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
BillData
object
32 properties
AddResponseResponse
object
Minimal response wrapper used by approval-style endpoints that don't carry the standard response envelope.
3 properties
1 required
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
Shippingcountry
string
Shipping address country.
BatchNumber
string
A unique identifier for the batch. This is generated by Payabli when the batch is created, and follows this format: paypointId + "" + serviceName + "" + batchD…
Device
string
Identifier of registered cloud device used in the transaction.
PendingFeeAmount
number
The difference between the configured pass-through fee and the fee amount sent in the request. When transferring funds, Payabli uses this field to deduct the f…
ChargebackMessage
object
8 properties
7 required
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
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…
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](…
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.
ChargeBackResponse
object
6 properties
Shippingcity
string
Shipping city.
EmvAuthResponseData
string
EMV authorization response data, applicable for card transactions.
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
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.
ChargebackQueryRecords
object
32 properties
28 required
QueryCFeeTransaction
object
8 properties
Replyby
string
Time that a response to a chargeback is due, in UTC.
ItemCommodityCode
string
Item or product commodity code. Max length of 250 characters.
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
RefundId
integer
Identifier of refund transaction linked to this payment.
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.
Accountzip
string
ZIP code for card used in transaction.
OrgParentName
string
The name of the parent organization.
BoardingApplicationAttachments
object
2 properties
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.
PaymentCategories
object
4 properties
2 required
ResultCodev2
string
Unified result code for the transaction. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
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.
PayorId
integer
Unique ID for the customer linked to the transaction. This is the same value as the customerId used when creating or referencing a customer.
Operation
string
The transaction's operation.
QueryTransactionEventsEventData
Any data associated to the event received from processor. Contents vary by event type.
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.
OrderId
string
Custom identifier for the transaction.
PairFiles
object
3 properties
QueryResponseData
object
The transaction's response data.
15 properties
AvsResponseText
string
Text code describing the result for address validation (applies only for card transactions).
Orderdescription
string
Text description of the transaction.
PurchaseOrder
string
Purchase order number.
PaymentDetail
object
Details about the payment.
8 properties
1 required
QueryTransactionEvents
object
3 properties
Authcode
string
Authorization code for the transaction.
Legalname
string
Business legal name.
ReturnedId
integer
Identifier of return/chargeback transaction linked to this payment.
TermsConditions
string
Custom terms and conditions included in the invoice.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Payabli publishes across the network.
