PayorData Object Model
Object model for the PayorData object
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:
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.
The Payabli-generated unique ID for the customer.
4440
Customer/Payor first name.
250
"John"
Customer/Payor last name.
250
"Doe"
Customer's company name.
250
"Sunshine LLC"
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
250
"3456-7645A"
Customer's billing address.
250
"123 Walnut Street"
Additional line for Customer's billing address.
100
"STE 900"
Customer's billing city.
250
"Johnson City"
Customer's billing state. Must be 2-letter state code for address in US.
250
"Johnson City"
Customer's billing ZIP code.
50
"37615"
Customer's billing country.
100
"US"
Customer's phone number.
50
"5555555555"
Customer's email address.
320
"example@email.com"
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
100
"US"
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
["email"]
Was this page helpful?