Payabli Customer API
The Customer API from Payabli — 4 operation(s) for customer.
Payabli Customer API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 6 operations across 4 paths, and defines 122 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.
6 operations
4 paths
122 schemas
1 DELETE2 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payabli Customer 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 6
Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Customer 6
POST
/Customer/single/{entry}
Add customer
GET
/Customer/{customerId}
Get customer record
PUT
/Customer/{customerId}
Update customer record
DELETE
/Customer/{customerId}
Delete customer record
GET
/Customer/link/{customerId}/{transId}
Link Customer to Transaction
POST
/Customer/{customerId}/consent
Request consent opt-in
Schemas 122
The contract defines 122 schemas that model the data the API accepts and returns. The most detailed are CustomerQueryRecords (44 properties), TransactionQueryRecords (40 properties), BillData (32 properties), SubscriptionQueryRecords (31 properties). Each schema is shown below with its type and property counts.
CustomerQueryRecordsCustomerConsent
object
2 properties
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).
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
MfaMode
integer
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.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
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…
QueryTransactionPayorData
object
22 properties
DutyAmount
number
Duty amount.
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…
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.
CustomerQueryRecords
object
44 properties
PayabliApiResponse00Responsedatanonobject
object
6 properties
1 required
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
PaypointId
integer
The paypoint's ID. Note that this is different than the entryname.
MethodQueryRecords
object
17 properties
SubscriptionQueryRecords
object
31 properties
5 required
CustomerData
object
Data about a single customer.
26 properties
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
CustomerSummaryRecord
object
4 properties
GeneralEvents
object
5 properties
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
PayabliApiResponseCustomerQuery
object
3 properties
1 required
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.
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…
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…
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).
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.
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.
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…
Responsedatanonobject
The response data.
OrgParentId
integer
The ID of the org's parent organization.
Timezone
integer
Timezone, in UTC offset. For example, -5 is Eastern time.
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.
Mfa
boolean
When true, multi-factor authentication (MFA) is enabled.
ShippingFromZip
string
Sender shipping ZIP code.
Invoicestatus
integer
Invoice status code.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
QueryCFeeTransaction
object
8 properties
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.
CustomerQueryRecordsCustomerConsentECommunication
object
Describes the customer's email communications consent status.
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.
ResultCodev2
string
Unified result code for the transaction. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
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.
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.
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
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.
QueryResponseData
object
The transaction's response data.
15 properties
AvsResponseText
string
Text code describing the result for address validation (applies only for card transactions).
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
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.
QueryTransactionEvents
object
3 properties
PaymentDetail
object
Details about the payment.
8 properties
1 required
Authcode
string
Authorization code for the transaction.
ReturnedId
integer
Identifier of return/chargeback transaction linked to this payment.
Legalname
string
Business legal name.
TermsConditions
string
Custom terms and conditions included in the invoice.
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 Export API
Payabli Funding API
Payabli ghostCard API
Payabli hostedPaymentPages API
Payabli Import API
Payabli Invoice API
Payabli lineItem API
#Customers
Where this information came from
This is an independent, third-party profile of Payabli Customer 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.