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:

"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.