This object contains data about a payor and is used in Pay In endpoints that require customerData.

In some cases, customerData is required, like when saving a payment method. The fields that are required depend on the paypoint’s identifier settings and the method or request you’re using.

When this object is required, you must include enough information for Payabli to identify the customer. If the paypoint isn’t using custom identifiers, then one of these values is required: customerID, firstname and lastname, email, or customerNumber. If the paypoint is using custom identifiers, use those.

Pass custom identifiers in the customerData.additionalData object like this:

"customerData": {
  "additionalData": {
    "YourCustomIdentifier": "123"
      }
    }

You can find the paypoint’s identifier settings in the web app at Settings > Custom Fields, or by calling /api/Paypoint/settings/{entry}.

Customer information. May be required, depending on the paypoint's settings. Required for subscriptions. See PayorData object Model for a complete reference.

​
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, pass those in this object. Example usage:

{
  "additionalData": {
    "CustomIdentifier": "value",
    "key2": "value2",
    "key3": "value3"
  }
}
​
billingAddress1
string | null

Customer's billing address.

Maximum length: 250
​
billingAddress2
string | null

Additional line for Customer's billing address.

Maximum length: 100
​
billingCity
string | null

Customer's billing city.

Maximum length: 250
​
billingCountry
string | null

Customer's billing country.

Maximum length: 100
​
billingEmail
string | null

Customer's email address.

Maximum length: 250
​
billingPhone
string | null

Customer's phone number.

Maximum length: 50
​
billingState
string | null

Customer's billing state. Must be 2-letter state code for address in US.

Maximum length: 250
​
billingZip
string | null

Customer's billing ZIP code.

Maximum length: 50
​
company
string | null

Customer's company name.

Maximum length: 250
​
customerId
integer | null

The Payabli-generated unique ID for the customer.

​
customerNumber
string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250
​
firstName
string | null

Customer/Payor first name.

Maximum length: 250
​
identifierFields
(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

​
lastName
string | null

Customer/Payor last name.

Maximum length: 250
​
shippingAddress1
string | null

The shipping address.

Maximum length: 250
​
shippingAddress2
string | null

Additional line for shipping address.

Maximum length: 100
​
shippingCity
string | null

Shipping city.

Maximum length: 250
​
shippingCountry
string | null

Shipping address country.

Maximum length: 100
​
shippingState
string | null

Shipping state or province.

​
shippingZip
string | null

Shipping ZIP code.

Maximum length: 50

Was this page helpful?

PaymentMethodTemplateData