API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Organization
- Paypoint
- Customer
- User
- Vendor
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Add Customer Record
Creates a customer in an entrypoint. An identifier is required to create customer records. Change your identifier settings in Settings > Custom Fields in PartnerHub.
If you don’t include an identifier, the record is rejected.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Headers
A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.
Path Parameters
The paypoint's entrypoint identifier. Learn more
Query Parameters
Flag indicating to replace existing customer with a new record Possible values: 0(do not replace), 1(replace). Default is "0"
When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.
Body
Data pertaining to single customer. See customerData Object Model for a complete reference.
Additional Custom fields in format "key":"value".
Customer address
Additional customer address
Customer balance.
Customer city
Company name
Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
Timestamp of when record was created, in UTC.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer password for customer portal
Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Customer username for customer portal
Customer email address
Customer first name
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Customer last name
Customer phone number
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping state or province.
Shipping ZIP code.
50Customer State
Timezone, in UTC offset. For example, -5 is Eastern time.
Customer zip code
Response
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
List of additional custom fields in format key:value.
Customer address.
Additional line for customer address.
Customer balance.
Customer city.
Company name.
Customer country.
Date and time created.
Describes the customer's email communications consent status.
Customers's consent status. Allowed status:
-
0: Customer hasn't opted in to communications
-
-1: Customer opt in pending
-
1: Customer has opted in to communications
Timestamp of when record was last updated, in UTC.
Describes the customer's SMS communications consent status.
Customers's consent status. Allowed status:
-
0: Customer hasn't opted in to communications
-
-1: Customer opt in pending
-
1: Customer has opted in to communications
Timestamp of when record was last updated, in UTC.
The Payabli-generated unique ID for the customer.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Number total of transactions or payments
List of more recent 5 transactions belonging to the customer
Batch amount.
Batch number.
Service Fee or sub-charge transaction associated to the main transaction.
Timestamp when transaction was submitted, in UTC.
Connector used for transaction.
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:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Customer's billing address.
Additional line for Customer's billing address.
Customer's billing city.
Customer's billing country.
Customer's email address.
Customer's phone number.
Customer's billing state. Must be 2-letter state code for address in US.
Customer's billing ZIP code.
Customer's company name.
Timestamp of when record was created, in UTC.
The Payabli-generated unique ID for the customer.
The Payabli-generated unique ID for the customer.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Customer/Payor first name.
Array of field names to be used as identifiers.
Customer/Payor last name.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping state or province.
Shipping ZIP code.
50Identifier of registered cloud device used in the transaction.
If applicable, the internal reference ID to the payment page capturing the payment.
Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions.
Service fee or sub-charge applied.
Internal identifier used for processing.
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:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Company name of the recipient of the invoice.
Discount applied to the invoice.
Duty amount.
First name of the recipient of the invoice.
Freight/shipping amount.
Frequency of scheduled invoice.
one-time, weekly, every2weeks, every6months, monthly, every3months, annually Invoice total amount.
Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice number. Identifies the invoice under a paypoint.
250Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0, 1, 2, 4, 99 Type of invoice. Only 0 for one-time invoices is currently supported.
Array of line items included in the invoice.
Last name of the recipient of the invoice.
Notes included in the invoice.
Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.
PIA, CIA, UR, NET10, NET20, NET30, NET45, NET60, NET90, EOM, MFI, 5MFI, 10MFI, 15MFI, 20MFI, 2/10NET30, UF, 10UF, 20UF, 25UF, 50UF Purchase order number.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping recipient's contact email address.
Sender shipping ZIP code.
Recipient phone number.
Shipping state or province.
Shipping ZIP code.
50Commodity code.
Tax rate in percent applied to the invoice.
Custom terms and conditions included in the invoice.
Payment method used: card, ach, or wallet.
Net amount paid.
The transaction's operation.
Custom identifier for the transaction.
250ID of immediate parent organization.
The name of the parent organization.
Expiration date of card used in transaction.
Custom identifier for payment connector.
250Bank account type or card brand.
ZIP code for card used in transaction.
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 be related to the DPAN (device primary account number), not the card connected to Apple Pay.
Account holder name for the method.
Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant.
Available values:
payor: For cardholder-initiated transactionsmerchant: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Text description of the transaction.
250Details about the payment.
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.
Available values:
first: The first use of the payment method. This is almost always a cardholder-initiated transaction.subsequent: For merchant-initiated transactions after the first use of the payment method.
See Understanding CIT and MIT Indicators for more information.
Identifier of stored payment method used in transaction.
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 unscheduled.
Available values:
unscheduled: This type is used for transactions that are one-time or otherwise not pre-scheduled.subscription: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.recurring: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.
See Understanding CIT and MIT Indicators for more information.
Unique Transaction ID.
Unique ID for customer linked to the transaction.
Paypoint's DBA name.
Paypoint's entryname.
50InternalId for paypoint.
Paypoint's legal name.
The difference between the configured pass-through fee and the fee amount sent in the request. When transfering funds, Payabli uses this field to deduct the fee difference and transfer the correct amount to the merchant.
When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See Fee Configuration to learn more about pass-through fee settings.
Identifier of refund transaction linked to this payment.
The transaction's response data.
Authorization code.
Text code describing the result for address validation (applies only for card transactions).
Text code describing the result for address validation (applies only for card transactions).
Text code describing the result for CVV validation (applies only for card transactions).
Text code describing the result for CVV validation (applies only for card transactions).
EMV authorization response data, applicable for card transactions.
Custom identifier for the transaction.
250Response text for operation: 'Success' or 'Declined'.
Internal result code processing the transaction. Value 1 indicates successful operation, values 2 and 3 indicate errors.
Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline.
Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline.
The transaction identifier in Payabli.
Type of transaction or operation.
Identifier of return/chargeback transaction linked to this payment.
Reference to the subscription that originated the transaction.
Settlement status for transaction. See the docs for a full reference.
Custom identifier to indicate the transaction or request source.
100Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
The accountId for the account the split should be sent to.
Amount from the transaction to sent to this recipient.
A description for the split.
The entrypoint the split should be sent to.
Transaction total amount (including service fee or sub-charge)
Events associated with this transaction.
Any data associated to the event received from processor. Contents vary by event type.
Date and time of event.
Event descriptor. See TransEvent Reference for more details.
Transaction date and time, in UTC.
Not currently in use.
Total amount in transactions
Total net amount in transactions
Username for customer.
Customer email address.
A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.
Customer first name.
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Customer last name.
Date and time of last update.
When true, multi-factor authentication (MFA) is enabled.
Auxiliary validation used internally by payment pages and components.
The name of the parent organization.
Paypoint DBA name.
The entrypoint identifier.
50Paypoint legal name.
Customer phone number.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping state or province.
Shipping ZIP code.
50Additional data provided by the social network related to the customer.
Identifier or token for customer in linked social network.
Social network linked to customer.
Possible values:
- twiter
- microsoft
Customer state.
List of payment methods associated to the customer.
The bank identification number (BIN). Null when method is ACH.
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 be related to the DPAN (device primary account number), not the card connected to Apple Pay.
The card brand. For example, Visa, MasterCard, American Express, Discover.
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID.
The name of the financial institution that issued the card.
The issuing financial institution's country name.
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
The type of card: Credit or Debit.
The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
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).
Expiration date associated to the method (only for card) in format MMYY.
Account holder name for the method.
Method internal ID
Date of last update
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Type of payment vehicle: ach or card
List of subscriptions associated to the customer.
Timestamp of when the subscription ws created, in UTC.
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:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Customer's billing address.
Additional line for Customer's billing address.
Customer's billing city.
Customer's billing country.
Customer's email address.
Customer's phone number.
Customer's billing state. Must be 2-letter state code for address in US.
Customer's billing ZIP code.
Customer's company name.
Timestamp of when record was created, in UTC.
The Payabli-generated unique ID for the customer.
The Payabli-generated unique ID for the customer.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Customer/Payor first name.
Array of field names to be used as identifiers.
Customer/Payor last name.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping state or province.
Shipping ZIP code.
50The subscription's end date.
If applicable, the internal reference ID to the payment page capturing the payment.
A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.
Fee applied to the subscription.
The subscription's frequency.
The subscription's ID.
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:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Company name of the recipient of the invoice.
Discount applied to the invoice.
Duty amount.
First name of the recipient of the invoice.
Freight/shipping amount.
Frequency of scheduled invoice.
one-time, weekly, every2weeks, every6months, monthly, every3months, annually Invoice total amount.
Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.
Invoice number. Identifies the invoice under a paypoint.
250Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0, 1, 2, 4, 99 Type of invoice. Only 0 for one-time invoices is currently supported.
Array of line items included in the invoice.
Item or product price per unit.
Item or product name. Max length of 250 characters.
250Quantity of item or product.
Array of tags classifying item or product.
Item or product commodity code. Max length of 250 characters.
250Item or product description. Max length of 250 characters.
250Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both.
0, 1, 2 Item or product code. Max length of 250 characters.
250Tax amount applied to item or product.
Tax rate applied to item or product.
Total amount in item or product.
Unit of measurement. Max length of 100 characters.
100Last name of the recipient of the invoice.
Notes included in the invoice.
Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.
PIA, CIA, UR, NET10, NET20, NET30, NET45, NET60, NET90, EOM, MFI, 5MFI, 10MFI, 15MFI, 20MFI, 2/10NET30, UF, 10UF, 20UF, 25UF, 50UF Purchase order number.
The shipping address.
250Additional line for shipping address.
100Shipping city.
250Shipping address country.
Shipping recipient's contact email address.
Sender shipping ZIP code.
Recipient phone number.
Shipping state or province.
Shipping ZIP code.
50Commodity code.
Tax rate in percent applied to the invoice.
Custom terms and conditions included in the invoice.
The last time the subscription was processed.
The last date and time the subscription was updated.
The number of cycles the subscription has left.
The subscription's payment method.
The subscription amount, minus any fees.
The next date the subscription will be processed.
The name of the parent organization.
Expiration date of card used in transaction.
Custom identifier for payment connector.
250Bank account type or card brand.
ZIP code for card used in transaction.
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 be related to the DPAN (device primary account number), not the card connected to Apple Pay.
The card brand. For example, Visa, MasterCard, American Express, Discover.
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID.
The name of the financial institution that issued the card.
The issuing financial institution's country name.
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
The type of card: Credit or Debit.
The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table.
Account holder name for the method.
Strongly recommended The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to merchant.
Available values:
payor: For cardholder-initiated transactionsmerchant: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Text description of the transaction.
250Details about the payment.
Total amount to be charged. If a service fee is sent, then this amount should include the service fee."
Array of payment categories/line items describing the amount to be paid Note: These categories are for information only and are not validated against the total amount provided.
Object containing image of paper check.
A check number to be used in the ach transaction. Required for payment method = 'check'.
Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.
Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.
Split funding instructions for the transaction. See Split a Transaction for more.
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli.
Available values:
first: The first use of the payment method. This is almost always a cardholder-initiated transaction.subsequent: For merchant-initiated transactions after the first use of the payment method.
See Understanding CIT and MIT Indicators for more information.
Identifier of stored payment method used in transaction.
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 unscheduled.
Available values:
unscheduled: This type is used for transactions that are one-time or otherwise not pre-scheduled.subscription: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions.recurring: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments.
See Understanding CIT and MIT Indicators for more information.
The paypoint's DBA name.
The paypoint's entryname.
50The paypoint's ID. Note that this is different than the entryname.
The paypoint's legal name.
Payment plan ID.
Custom identifier to indicate the transaction or request source.
100The subscription start date.
Events associated with the subscription.
Event description.
Event timestamp, in UTC.
Extra data.
Reference data.
The event source.
100The subscription's status.
- 0: Paused
- 1: Active
The subscription amount, including any fees.
The total number of cycles the subscription is set to run.
When true, the subscription has no explicit end date and will run until canceled.
Timezone, in UTC offset. For example, -5 is Eastern time.
Customer zip code.
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?