Custom Identifiers for Developers
Learn how custom identifiers work to help you manage customers with the Payabli APIs
By default, when working with the API on any task that involves customer data, you must include at least one of these identifier fields:
firstname
andlastname
email
customerId
These tasks include things like making transactions, working with customer records, managing invoices, and more. Payabli first searches to match customer records based on your custom identifiers. If you don’t have any custom identifiers set, then Payabli falls back to matching on customerId
.
Custom identifiers are managed in PartnerHub by navigating to Settings > Custom Fields.
Custom identifiers give you the flexibility to match customers in Payabli using the conventions you already use.
Payabli recommends using the system-generated customerId
field to identify customers for ease of integration and consistency. However, you can configure custom identifiers, which lets you decide which customer profile fields to use to uniquely identify and associate customer records and payments.
For example. if your company uses the customer’s email address as their unique identifier, you can choose email
as the identifier. If your organization prefers to identify customers by a field called clientId
, you can create that custom identifier field in Payabli. This means that every API call that involves a customer must include the clientID
because Payabli uses that field to search for customers.
Click to zoom
Pass custom identifiers in the customerData.additionalData
object like this:
Was this page helpful?