API referencePay In endpointsCustomer

Get customer

Retrieves a customer's record and details.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

customerIdintegerRequired

Payabli-generated customer ID. Maps to “Customer ID” column in PartnerHub.

Response

Success
AdditionalFieldsmap from strings to optional strings

List of additional custom fields in format key:value.

Addressstring
Customer address.
Address1string
Additional line for customer address.
Balancedouble
Customer balance.
Citystring
Customer city.
Companystring
Company name.
Countrystring
Customer country.
Createddatetime
Date and time created.
customerConsentobject
customerIdlong

The Payabli-generated unique ID for the customer.

customerNumberstring<=250 characters

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

customerStatusinteger

Customer Status. Possible values:

  • -99 Deleted
  • 0 Inactive
  • 1 Active
  • 85 Locked (typically due to multiple failed login attempts)
customerSummaryobject
customerUsernamestring
Username for customer.
Emailstringformat: "email"<=320 characters
Customer email address.
externalPaypointIDstring

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.

Firstnamestring
Customer first name.
IdentifierFieldslist of optional strings
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Lastnamestring
Customer last name.
LastUpdateddatetime
Date and time of last update.
MFAboolean

When true, multi-factor authentication (MFA) is enabled.

MFAModeinteger
pageidentifierstring
Auxiliary validation used internally by payment pages and components.
ParentOrgNamestring
The name of the parent organization.
PaypointDbanamestring
Paypoint DBA name.
PaypointEntrynamestring<=50 characters
The entrypoint identifier.
PaypointLegalnamestring
Paypoint legal name.
Phonestring
Customer phone number.
ShippingAddressstring<=250 characters
The shipping address.
ShippingAddress1string<=100 characters
Additional line for shipping address.
ShippingCitystring<=250 characters
Shipping city.
ShippingCountrystring
Shipping address country.
ShippingStatestring
Shipping state or province.
ShippingZipstring<=50 characters

Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: “37615-1234” or “37615”.

snDatastring
Additional data provided by the social network related to the customer.
snIdentifierstring
Identifier or token for customer in linked social network.
snProviderstring

Social network linked to customer.
Possible values:

  • facebook
  • google
  • twiter
  • microsoft
Statestring
Customer state.
StoredMethodslist of objects
List of payment methods associated to the customer.
Subscriptionslist of objects
List of subscriptions associated to the customer.
TimeZoneinteger

Timezone, in UTC offset. For example, -5 is Eastern time.

Zipstring
Customer zip code.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error