Payabli Query API
The Query API from Payabli — 42 operation(s) for query.
Payabli Query API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Query. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 42 operations across 42 paths, and defines 392 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
42 operations
42 paths
392 schemas
42 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payabli Query API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the header as requestToken (APIKeyAuth).
BearerAuth— OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).APIKeyAuth— Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).
Paths & Operations 42
Across 42 paths, the API surfaces 42 operations — 42 GET. Each is listed below with its method, path, parameters, and response codes.
Query 42
GET
/Query/transactions/{entry}
Get list of transactions for a paypoint
GET
/Query/transactions/org/{orgId}
Get list of transactions for an organization
GET
/Query/settlements/{entry}
Get list of settled transactions for a paypoint
GET
/Query/settlements/org/{orgId}
Get list of settled transactions for an org
GET
/Query/batches/{entry}
Get list of batches for a paypoint
GET
/Query/batches/org/{orgId}
Get list of batches for an organization
GET
/Query/batchDetails/{entry}
Get a list of settled and unsettled transactions in batches for a paypoint
GET
/Query/batchDetails/org/{orgId}
Get list of settled and unsettled transactions in batches for an org
GET
/Query/transfers/{entry}
Get list of transfers for a paypoint
GET
/Query/transfers/org/{orgId}
Get list of transfers for an organization
GET
/Query/transferDetails/{entry}/{transferId}
Get transfer details for a paypoint
GET
/Query/subscriptions/{entry}
Get list of subscriptions for a paypoint
GET
/Query/subscriptions/org/{orgId}
Get list of subscriptions for an org
GET
/Query/customers/{entry}
Get list of customers for a paypoint
GET
/Query/customers/org/{orgId}
Get list of customers for an org
GET
/Query/devices/{entry}
Get list of devices for a paypoint
GET
/Query/devices/org/{orgId}
Get list of devices for an org
GET
/Query/chargebacks/{entry}
Get list of chargebacks and returned transactions for a paypoint
GET
/Query/chargebacks/org/{orgId}
Get list of chargebacks and returned transactions for an org
GET
/Query/payoutsubscriptions/{entry}
Get list of payout subscriptions for a paypoint
GET
/Query/payoutsubscriptions/org/{orgId}
Get list of payout subscriptions for an org
GET
/Query/batchesOut/{entry}
Get list of MoneyOut batches for a paypoint
GET
/Query/batchesOut/org/{orgId}
Get list of MoneyOut batches for an org
GET
/Query/payouts/{entry}
Get list of money out transactions for paypoint
GET
/Query/payouts/org/{orgId}
Get list of money out transactions for organization
GET
/Query/vcards/{entry}
Get list of virtual cards for entrypoint
GET
/Query/vcards/org/{orgId}
Get list of virtual cards for an organization
GET
/Query/vcardsTransactions/{entry}
Get list of virtual card transactions for entrypoint
GET
/Query/vcardsTransactions/org/{orgId}
Get list of virtual card transactions for an organization
GET
/Query/transfersOut/org/{orgId}
Get list of outbound transfers for an organization
GET
/Query/transfersOut/{entry}
Get list of outbound transfers for a paypoint
GET
/Query/transferDetailsOut/{entry}/{transferId}
Get outbound transfer details
GET
/Query/vendors/{entry}
Get list of vendors for entrypoint
GET
/Query/vendors/org/{orgId}
Get list of vendors for organization
GET
/Query/notifications/{entry}
Get list of notifications for an entrypoint
GET
/Query/notifications/org/{orgId}
Get list of notifications for organization
GET
/Query/notificationReports/{entry}
Get list of reports generated in last 60 days for entrypoint
GET
/Query/notificationReports/org/{orgId}
Get list of reports generated in last 60 days for organization
GET
/Query/users/org/{orgId}
Get list of users for an org
GET
/Query/users/point/{entry}
Get list of users for paypoint
GET
/Query/organizations/{orgId}
Get list of organizations for a parent
GET
/Query/paypoints/{orgId}
Get list of paypoints for an organization
Schemas 392
The contract defines 392 schemas that model the data the API accepts and returns. The most detailed are TransferDetailRecord (70 properties), TransferOutDetailRecord (63 properties), BatchDetailResponseRecord (55 properties), QueryEntrypointResponseRecordsItem (54 properties). Each schema is shown below with its type and property counts.
IsSameDayACH
boolean
When true, this is a same-day ACH transaction.
Idpaypoint
integer
The paypoint's ID in Payabli.
Shippingaddress
string
The shipping address.
AvsResponse
string
Text code describing the result for address validation (applies only for card transactions).
TransferOutDetailVendorBillingData
object
Billing data for a vendor.
15 properties
15 required
BankName
string
Name of bank for account.
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).
ReplyToEmail
string
Email address for organization-level communications, such as messages about why an application was declined. This is required by commerce laws in the US.
FrequencyList
object
7 properties
QueryResponseNotificationsRecordsItem
object
12 properties
QueryPayoutTransactionSummary
object
20 properties
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.
BillingCountryNullable
string
Billing address country.
Bphone
string
Business phone number.
OrgData
object
6 properties
AbsorbDifference
boolean
Whether the paypoint absorbs the difference between the configured service fee and the actual fee charged to the customer.
NotificationContentFileFormat
string
Indicate the format of report file to be generated by the engine. Used for method = report-email and report-web.
Orgcity
string
The organization's city.
QueryTransactionPayorData
object
22 properties
Instrument
object
7 properties
2 required
PayoutSubscriptionQueryRecordPascal
object
29 properties
4 required
Bcountry
string
Business country in ISO-3166-1 alpha 2 format. See [ISO 3166-1](https://en.wikipedia.org/wiki/ISO3166-1) for more information.
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
Holdername
string
The cardholder name.
Shippingstate
string
Shipping state or province.
CustomerQueryRecords
object
44 properties
FeeAmount
number
Service fee or sub-charge applied.
EnrollmentStatus
string
Enrollment status of vendor in payables program.
ExternalProcessorInformation
string
Information from the external processor about the transaction.
Baddress2
string
Business address additional line. If used, this must be the physical address of the business, not a P.O. box.
Mcountry
string
Business mailing country.
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
OdpSetup
object
6 properties
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.
MethodQueryRecords
object
17 properties
SubscriptionQueryRecords
object
31 properties
5 required
Category
string
A field used internally by Payabli to categorize the transaction details. Values are: - auth: Any payment - refund: ACH return or Refund - adj: Adjustments - c…
LocationCode
string
A location code used to identify the vendor's location.
ButtonElementSize
string
Specify the size of the custom payment button.
GeneralEvents
object
5 properties
BillingDataResponse
object
14 properties
13 required
TransferOutDetailEvent
object
Event data for an outbound transfer detail.
3 properties
3 required
VendorQueryRecord
object
53 properties
Device
string
Identifier of registered cloud device used in the transaction.
CustomerQueryRecordsCustomerConsentSms
object
Describes the customer's SMS communications consent status.
2 properties
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…
TransferMessageProperties
object
2 properties
2 required
Signaturedata
string
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
Avgmonthly
number
Average total amount of transactions in your local currency that are processed each month.
QueryBatchesDetailResponse
object
Response body for queries about batch details.
2 properties
2 required
BatchDetailResponseSummary
object
10 properties
10 required
Descriptor
string
When the method is a card, this field displays card brand. When the method is ACH, this field displays the account type for ACH (checking or savings).
PaypointData
object
23 properties
QueryResponseSettlements
object
Describes the response for settlement queries.
2 properties
Orgname
string
The name of the organization.
SplitFundingContent
object
4 properties
VCardSummary
object
9 properties
6 required
QueryBatchesTransfer
object
Transfer details within a batch response.
14 properties
14 required
GreaterValueAllowed
boolean
When true, the customer can pay an amount greater than the invoice or bill amount.
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…
DeviceQueryRecord
object
24 properties
24 required
SettlementStatus
integer
Settlement status for transaction. See [the docs](/developers/references/money-in-statusespayment-funding-status) for a full reference.
FileContentFtype
string
The MIME type of the file (if content is provided).
EmvAuthResponseData
string
EMV authorization response data, applicable for card transactions.
OrganizationQueryRecordServicesItem
object
8 properties
TransferIdentifier
string
Unique identifier for the transfer.
Timezone
integer
Timezone, in UTC offset. For example, -5 is Eastern time.
QueryPaymentData
object
14 properties
NotificationId
integer
The notification's Payabli identifier. This is the ID used to manage the notification.
Invoicestatus
integer
Invoice status code.
TransferOutRecord
object
A record representing an outbound transfer.
36 properties
36 required
NetAmountstring
string
Net amount owed in bill. Required when adding a bill.
OrgXScope
object
3 properties
Replyby
string
Time that a response to a chargeback is due, in UTC.
PayabliPages
object
11 properties
TransferOutDetailBill
object
Bill information for an outbound transfer detail.
15 properties
15 required
TransferOutDetailQueryResponse
object
Response body for queries about outbound transfer details.
2 properties
2 required
BankData
array
Information about associated bank accounts.
ItemCommodityCode
string
Item or product commodity code. Max length of 250 characters.
RefundId
integer
Identifier of refund transaction linked to this payment.
Accountzip
string
ZIP code for card used in transaction.
Contacts
object
5 properties
Whendelivered
string
When goods and services are delivered.
QueryResponseNotifications
object
Response payload for queries related to notifications
2 properties
BillingZip
string
Billing address ZIP code.
QueryPayoutSubscriptionResponse
object
Payout subscription query response body.
2 properties
VCardQueryResponse
object
2 properties
AddressNullable
string
The address.
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.
PaypointEntryConfig
object
8 properties
Whenrefunded
string
Describes the business refund policy.
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
Bsummary
string
A summary of what the business sells in terms of goods or services.
LabelElement
object
3 properties
TypeAccount
string
Type of bank account: Checking or Savings.
StatementEmailConfig
object
Configuration for statement email recipients and the sender address.
2 properties
AccountNumber
string
Account number for bank account. This value is returned masked in responses.
Ownerid
integer
ID for the paypoint or organization that owns the notification. If the ownerType field is 0, this field is the same as the orgId for the organization that owns…
AddressAddtlNullable
string
Additional line for the address.
Discount
number
Discount applied to the invoice.
RiskReason
string
Reason for risk flagging.
CustomerQueryRecordsCustomerConsent
object
2 properties
QuerySummary
object
6 properties
NotificationContentEventType
string
The notification's event name.
FreightAmount
number
Freight/shipping amount.
SettlementStatusPayout
string
The settlement status of the payout transaction. See [Payout Transaction Statuses](/guides/pay-out-status-referencepayout-transaction-statuses) for a full refe…
Licensestate
string
Business license issuing state or province.
MfaMode
integer
CvvResponseText
string
Text code describing the result for CVV validation (applies only for card transactions).
QueryEntrypointResponse
object
2 properties
Enabled
boolean
Toggles whether the section or element is enabled.
Accountexp
string
Expiration date of card used in transaction.
RemitEmail
string
Remittance email address. Used for sending virtual cards and other information about payouts.
SummaryCommodityCode
string
Commodity code.
QueryChargebacksResponseRecordsItem
object
27 properties
PayabliCredentials
object
13 properties
HeaderElement
object
3 properties
Order
integer
Order of element or section in container.
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
AchHolderType
string
The bank's accountholder type: personal or business.
QueryBatchesResponse
object
Response body for queries about batches.
2 properties
2 required
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
PaypointSummary
object
5 properties
Language
string
The language code.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
Orgwebsite
string
The organization's website.
OrganizationQueryRecord
object
27 properties
DisplayProperty
object
3 properties
PaypointId
integer
The paypoint's ID. Note that this is different than the entryname.
RoutingAccount
string
Routing number of bank account.
Bank
object
Object that contains bank account details.
15 properties
RiskActionCode
integer
Numeric code representing the risk action.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
KeyValueDuo
object
2 properties
QueryUserResponse
object
2 properties
Shippingcountry
string
Shipping address country.
BankNickname
string
User-defined name for the bank account.
QueryBatchesOutResponse
object
Response body for queries about money out batches.
2 properties
2 required
QueryResponseVendors
object
Response payload for queries related to vendors.
2 properties
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…
CardSetup
object
4 properties
BankAccountHolderName
string
The accountholder's name.
TransferBankAccount
object
3 properties
3 required
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](…
Remitaddress2
string
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
Highticketamt
number
Highest ticket amount.
Orgtimezone
integer
The org's timezone, in UTC offset. For example, -5 is Eastern time.
Shippingcity
string
Shipping city.
MethodElementSettingsApplePayLanguage
string
The Apple Pay button locale. See [Apple Pay Button Language](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-language) for more inform…
RecipientEmailNotification
boolean
When true, Payabli will send the applicant a boarding link. Set this value to false if you are sending pre-filled applications via the API and don't want Payab…
VCardCardType
integer
The type of virtual card: - Single-use virtual card: 0 - Ghost card: 2
QuerySubscriptionResponse
object
Subscription query response body.
2 properties
Mcc
string
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcccodes.csv) lists MCC codes.
Mstate
string
The business's mailing address state.
SalesCode
string
QueryBatchesOutResponseRecordsItem
object
41 properties
Shippingaddressadditional
string
Additional line for shipping address.
Mfa
boolean
When true, multi-factor authentication (MFA) is enabled.
ShippingFromZip
string
Sender shipping ZIP code.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
TransferMessage
object
8 properties
8 required
Binweb
integer
Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.
Remitaddress1
string
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
PaypointName
string
The paypoint name.
QueryResponseNotificationReportsRecordsItem
object
4 properties
Binperson
integer
Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.
Avgticketamt
number
Average ticket amount.
SettingElement
object
5 properties
QueryTransferDetailResponse
object
2 properties
2 required
QueryPayoutTransaction
object
2 properties
ExportFormat
string
Export format for file downloads. When specified, returns data as a file instead of JSON.
Netamountnullable
number
Net amount.
Achrouting
string
ABA/routing number of Bank account.
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…
Operation
string
The transaction's operation.
VendorSummary
object
16 properties
QueryEntrypointResponseRecordsItem
object
54 properties
InvoiceAmount
number
The invoice amount.
Source
string
Custom identifier to indicate the transaction or request source.
QueryDeviceResponse
object
Response body for queries about cloud devices.
2 properties
2 required
Taxfillname
string
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
Bzip
string
Business ZIP.
UsrAccess
object
2 properties
limitRecord
integer
Max number of records to return for the query. Use 0 or negative value to return all records. Defaults to 20.
ButtonElement
object
2 properties
1 required
Orgtype
integer
The organization type. Currently, this must be 0.
TransferDetailRecord
object
70 properties
70 required
QueryResponseSettlementsSummary
object
10 properties
Authcode
string
Authorization code for the transaction.
Finishtype
object
2 properties
TermsConditions
string
Custom terms and conditions included in the invoice.
Orgaddress
string
The organization's address.
IpAddress
string
The IP address associated with the transaction.
TransferQueryResponse
object
2 properties
2 required
ContactsField
array
List of contacts.
AccountId
string
Custom identifier for payment connector.
VCardRecord
object
28 properties
MethodElementSettingsApplePayButtonStyle
string
The Apple Pay button style. See [Apple Pay Button Style](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-style) for more inform…
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).
Bstate
string
Business state.
RiskFlaggedOn
string
Timestamp when the transaction was flagged for risk.
BillingStateNullable
string
Billing state. Must be a 2-letter state code for addresses in the US.
CityNullable
string
The city.
PayabliCredentialsPascal
object
15 properties
ItemUnitofMeasure
string
Unit of measurement. Max length of 100 characters.
Transfer
object
32 properties
32 required
DutyAmount
number
Duty amount.
Vendorid
integer
Payabli identifier for vendor record.
RiskStatus
string
Current risk status of the transaction.
Busstartdate
string
Business start date. Accepted formats: - YYYY-MM-DD - MM/DD/YYYY
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.
BatchDetailResponseRecord
object
55 properties
52 required
Remitcountry
string
Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.
BankAccountFunction
integer
Indicates the function of the bank account: - 0 — Deposits - 1 — Withdrawals - 2 — Deposits & Withdrawals - 3 — Remittances - 4 — Remittances & Deposits - 5 —…
CustomerId
integer
The Payabli-generated unique ID for the customer.
TransactionQueryRecords
object
40 properties
2 required
PaymentIdString
string
The unique transaction ID. This value is a string representation of a long integer.
Comments
string
Any comment or description.
BillData
object
32 properties
MethodElementSettings
object
Settings for wallet payment methods.
1 property
CountryNullable
string
The country in ISO-3166-1 alpha 2 format. See [ISO 3166-1](https://en.wikipedia.org/wiki/ISO3166-1) for reference.
Orgentryname
string
The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
CustomerSummaryRecord
object
4 properties
Ein
string
Business EIN or tax ID. This value is masked in API responses.
AllowOverride
boolean
Whether the configured service fee can be overridden at the transaction level.
Orgstate
string
The organization's state.
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…
VendorNumber
string
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
OwnType
string
The business ownership type.
QueryPayoutTransactionRecordsItemPaymentData
object
18 properties
ContactsResponse
object
4 properties
Services
object
Controls which services will be enabled for the merchant.
3 properties
BillingFeeDetail
object
11 properties
PageElement
object
4 properties
QueryResponseTransactions
object
Response payload for queries related to transactions
2 properties
Accounttype
string
Bank account type or card brand.
Bcity
string
Business city.
TransferOutDetailBillAttachment
object
Attachment for a bill.
5 properties
5 required
Whenprovided
string
Describes when goods or services are provided, from time of transaction.
TransferOutSummary
object
Summary information for outbound transfer queries.
3 properties
3 required
PayoutProgram
string
The payout program associated with the transaction. Values are Managed (managed payables) or ODP (on-demand payables).
MaxTicket
number
Maximum ticket amount for transactions within the paypoint. Contact Payabli support to request a change to this value.
Frequency
string
Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (s…
TransferOutDetailRecord
object
A record representing an outbound transfer detail.
63 properties
63 required
LastModified
string
Timestamp of when record was last updated, in UTC.
QueryResponseSettlementsRecordsItem
object
35 properties
Remitcity
string
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
QueryCFeeTransaction
object
8 properties
ListOrganizationsResponse
object
2 properties
2 required
MethodElement
object
8 properties
Achaccount
string
Bank account number.
Gatewayfield
string
The payment gateway used to process the transaction.
TransferOutBankAccount
object
Bank account information for an outbound transfer.
3 properties
3 required
MethodsList
object
10 properties
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.
VCardTransactionRecord
object
A virtual card transaction record returned by the query.
27 properties
27 required
CustomerQueryRecordsCustomerConsentECommunication
object
Describes the customer's email communications consent status.
2 properties
EntrypageId
integer
If applicable, the internal reference ID to the payment page associated with the transaction.
PayorFields
object
10 properties
PaymentCategories
object
4 properties
2 required
TransferOutQueryResponse
object
Response body for queries about outbound transfers.
2 properties
2 required
Ownertype
integer
Entity owner type. Accepted values: - 0: Organization/partner - 2: Paypoint
TransferOutMessage
object
A message associated with an outbound transfer.
8 properties
8 required
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…
PhoneNumber
string
Phone number.
UserQueryRecord
object
17 properties
PayorElement
object
4 properties
AmountElement
object
3 properties
Zip
string
ZIP code for address.
InvoiceType
integer
Invoice type. Value 0 is for single/one-time invoices, 1 for scheduled invoices.
OrderId
string
Custom identifier for the transaction.
RiskAction
string
Action taken due to risk assessment.
Totalpages
integer
Total number of pages in response.
AvsResponseText
string
Text code describing the result for address validation (applies only for card transactions).
QueryResponseNotificationReports
object
2 properties
Orderdescription
string
Text description of the transaction.
QueryPayoutTransactionRecordsItem
object
49 properties
PurchaseOrder
string
Purchase order number.
Identifierfields
array
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
QueryTransactionEvents
object
3 properties
Legalname
string
Business legal name.
ReturnedId
integer
Identifier of return/chargeback transaction linked to this payment.
NameUser
string
ContactElement
object
6 properties
SummaryOrg
object
6 properties
TransferOutEventData
object
Event data associated with an outbound transfer.
4 properties
4 required
Orgcountry
string
The organization's country.
OdpSetupProcessingRegion
string
Region where payment processing occurs.
MinTicket
number
Minimum ticket amount for transactions within the paypoint. Contact Payabli support to request a change to this value.
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
PayoutGatewayConnector
object
9 properties
Email
string
Email address.
RetrievalId
integer
Identifier of retrieval request.
CustomerStatus
integer
Customer Status. Possible values: - -99 Deleted - 0 Inactive - 1 Active - 85 Locked (typically due to multiple failed login attempts)
Element
object
2 properties
Orgzip
string
The organization's ZIP code.
PayeeName
string
Alternative name used to receive paper check.
TransactionTime
string
Timestamp when transaction was submitted, in UTC.
Entrypointfield
string
The entrypoint identifier.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
ChargebackId
integer
Identifier of chargeback transaction.
Pagesize
integer
Number of records on each response page.
OptinStatus
integer
Customer's consent status. Allowed status: - 0: Customer hasn't opted in to communications - -1: Customer opt in pending - 1: Customer has opted in to communic…
ItemDescription
string
Item or product description. Max length of 250 characters.
Orgidstring
string
An alternate ID for the organization, in string format. This can be your internal identifier for an org, and is typically a name, like "My Suborganization".
BillPayOutData
object
15 properties
2 required
InternalReferenceId
integer
An internal reference ID.
IsRoot
boolean
When true, indicates that this is the organization's root template.
NotificationContentReportName
string
The kind of report to generate. For [automated reports](/developers/developer-guides/notifications-and-webhooks-overviewautomated-reports) only.
TransferOutMessageProperties
object
Properties associated with a transfer message.
2 properties
2 required
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
Whencharged
string
Describes when customers are charged for goods or services.
ItemProductCode
string
Item or product code. Max length of 250 characters.
PageSetting
object
7 properties
NoteElement
object
5 properties
ScheduleId
integer
ID of the recurring payment schedule associated with the transaction.
Mzip
string
Business mailing ZIP.
CustomerData
object
Data about a single customer.
26 properties
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"…
Totalrecords
integer
Total number of records in response.
QueryChargebacksResponse
object
Response body for queries about chargebacks.
2 properties
InvoiceElement
object
4 properties
BillingAddressNullable
string
Billing address.
AutoElement
object
7 properties
BoardingId
integer
The Payabli-assigned ID of the boarding application linked to this paypoint.
Website
string
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
Paypointstatus
integer
The paypoint's status. - 1 — Active - 0 — Inactive
MethodElementSettingsApplePayButtonType
string
The text on Apple Pay button. See [Apple Pay Button Type](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-type) for more inform…
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…
ExpectedDepositDate
string
The date the funds are expected to be deposited.
DepositDate
string
The date the funds were deposited.
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](…
TransferOutDetailVendor
object
Vendor information for an outbound transfer detail.
45 properties
45 required
PayCategory
object
9 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…
Ownership
array
List of Owners with at least a 25% ownership.
AccountingField
string
Optional custom field.
Target
string
Specify the notification target. For method=email the expected value is a list of email addresses separated by semicolon. For method=sms the expected value is…
Entry
string
The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overviewentrypoint-vs-entry).
BatchSummary
object
6 properties
License
string
Business license ID or state ID number.
OrgParentId
integer
The ID of the org's parent organization.
Methodnotification
string
Method to use to send the notification to the target.
TemplateId
integer
The associated boarding template's ID in Payabli.
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 -…
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
QueryCustomerResponse
object
2 properties
Resumable
boolean
When true, the applicant can save an incomplete application and resume it later. When false, the applicant won't have an option to save their progress, and mus…
TransferOutDetailPaymentData
object
Payment data for an outbound transfer detail.
16 properties
16 required
HasVcardTransactions
boolean
When true, indicates that the paypoint has vCard transactions.
UsrStatus
integer
The user's status: - Inactive: 0 - Active: 1 - Deleted: -99 - Locked: 85
Maddress1
string
Additional line for the business's mailing address.
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
Frequencynotification
string
Frequency for notifications.
Terms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30.
TransStatus
integer
Status of transaction. See [the docs](/developers/references/money-in-statusesmoney-in-transaction-status) for a full reference.
OrgParentName
string
The name of the parent organization.
ReceiptContent
object
Object containing receipt body configuration
9 properties
Maddress
string
The business's mailing address.
Binphone
integer
Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.
SettlementStatusName
stringnull
Name of the settlement status.
PageContent
object
15 properties
StateNullable
string
The state or province.
SplitFunding
array
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
SettlementSplitFundingDetail
object
A split funding instruction on a settled transaction, enriched with the batch and transfer that paid out the split when that information is available. Returned…
7 properties
Baddress1
string
Business address. This must be a physical address, not a P.O. box.
NotificationContent
object
7 properties
QueryBatchesResponseRecordsItem
object
30 properties
30 required
QueryTransactionEventsEventData
Any data associated to the event received from processor. Contents vary by event type.
Mcity
string
The business's mail city.
QueryTransferSummary
object
21 properties
21 required
QueryResponseData
object
The transaction's response data.
15 properties
AssociatedVendor
object
41 properties
Owners
object
16 properties
TransferOutDetailCheckData
object
Check data for an outbound transfer detail.
2 properties
2 required
RiskFlagged
boolean
Indicates if the transaction was flagged for risk.
PaymentDetail
object
Details about the payment.
8 properties
1 required
TransferSummary
object
3 properties
3 required
MethodElementSettingsApplePay
object
3 properties
Statusnotification
integer
Status of notification: - 0: Inactive - 1: Active
VCardTransactionQueryResponse
object
Response body for queries about virtual card transactions.
2 properties
2 required
AchSetup
object
Configuration for which ACH SEC codes the user is allowed to use.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Payabli 12
Other APIs Payabli publishes across the network.
Payabli Bill API
Payabli Boarding API
Payabli chargeBacks API
Payabli checkCapture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli ghostCard API
Payabli hostedPaymentPages API
Payabli Import API
Payabli Invoice API
#Query
Where this information came from
This is an independent, third-party profile of Payabli Query API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.