API referencePay In endpointsCustomer

Get customer

Retrieves a customer's record and details.

Path parameters

customerIdintegerRequired

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

Headers

requestTokenstringRequired

Response

Success
customerIdlong or null

The Payabli-generated unique ID for the customer.

customerNumberstring or null<=250 characters

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

customerUsernamestring or null
Username for customer.
customerStatusinteger or null

Customer Status. Possible values:

  • -99 Deleted
  • 0 Inactive
  • 1 Active
  • 85 Locked (typically due to multiple failed login attempts)
Companystring or null
Company name.
Firstnamestring or null
Customer first name.
Lastnamestring or null
Customer last name.
Phonestring or null
Customer phone number.
Emailstring or nullformat: "email"<=320 characters
Customer email address.
Addressstring or null
Customer address.
Address1string or null
Additional line for customer address.
Citystring or null
Customer city.
Statestring or null
Customer state.
Zipstring or null
Customer zip code.
Countrystring or null
Customer country.
ShippingAddressstring or null<=250 characters
The shipping address.
ShippingAddress1string or null<=100 characters
Additional line for shipping address.
ShippingCitystring or null<=250 characters
Shipping city.
ShippingStatestring or null
Shipping state or province.
ShippingZipstring or null<=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”.

ShippingCountrystring or null
Shipping address country.
Balancedouble or null
Customer balance.
TimeZoneinteger or null

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

MFAboolean or null

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

MFAModeinteger or null
snProviderstring or null

Social network linked to customer.
Possible values:

  • facebook
  • google
  • twiter
  • microsoft
snIdentifierstring or null
Identifier or token for customer in linked social network.
snDatastring or null
Additional data provided by the social network related to the customer.
LastUpdateddatetime or null
Date and time of last update.
Createddatetime or null
Date and time created.
AdditionalFieldsmap from strings to optional strings or null

List of additional custom fields in format key:value.

IdentifierFieldslist of optional strings or null
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Subscriptionslist of objects or null
List of subscriptions associated to the customer.
StoredMethodslist of objects or null
List of payment methods associated to the customer.
customerSummaryobject or null
PaypointLegalnamestring or null
Paypoint legal name.
PaypointDbanamestring or null
Paypoint DBA name.
ParentOrgNamestring or null
The name of the parent organization.
ParentOrgIdlong or null
The ID of the org's parent organization.
PaypointEntrynamestring or null<=50 characters
The entrypoint identifier.
pageidentifierstring or null
Auxiliary validation used internally by payment pages and components.
externalPaypointIDstring or null

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.

customerConsentobject or null

Errors