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

AdditionalFieldsmap from strings to optional stringsOptional

List of additional custom fields in format key:value.

AddressstringOptional

Customer address.

Address1stringOptional

Additional line for customer address.

BalancedoubleOptional

Customer balance.

CitystringOptional

Customer city.

CompanystringOptional

Company name.

CountrystringOptional

Customer country.

CreateddatetimeOptional

Date and time created.

customerConsentobjectOptional
customerIdlongOptional

The Payabli-generated unique ID for the customer.

customerNumberstringOptional<=250 characters

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

customerStatusintegerOptional

Customer Status. Possible values:

  • -99 Deleted
  • 0 Inactive
  • 1 Active
  • 85 Locked (typically due to multiple failed login attempts)
customerSummaryobjectOptional
customerUsernamestringOptional

Username for customer.

EmailstringOptionalformat: "email"<=320 characters

Customer email address.

externalPaypointIDstringOptional

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.

FirstnamestringOptional

Customer first name.

IdentifierFieldslist of optional stringsOptional

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

LastnamestringOptional

Customer last name.

LastUpdateddatetimeOptional

Date and time of last update.

MFAbooleanOptional

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

MFAModeintegerOptional
pageidentifierstringOptional

Auxiliary validation used internally by payment pages and components.

ParentOrgNamestringOptional

The name of the parent organization.

PaypointDbanamestringOptional

Paypoint DBA name.

PaypointEntrynamestringOptional<=50 characters

The entrypoint identifier.

PaypointLegalnamestringOptional

Paypoint legal name.

PhonestringOptional

Customer phone number.

ShippingAddressstringOptional<=250 characters

The shipping address.

ShippingAddress1stringOptional<=100 characters

Additional line for shipping address.

ShippingCitystringOptional<=250 characters

Shipping city.

ShippingCountrystringOptional

Shipping address country.

ShippingStatestringOptional

Shipping state or province.

ShippingZipstringOptional<=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”.

snDatastringOptional

Additional data provided by the social network related to the customer.

snIdentifierstringOptional

Identifier or token for customer in linked social network.

snProviderstringOptional

Social network linked to customer.
Possible values:

  • facebook
  • google
  • twiter
  • microsoft
StatestringOptional

Customer state.

StoredMethodslist of objectsOptional

List of payment methods associated to the customer.

Subscriptionslist of objectsOptional

List of subscriptions associated to the customer.

TimeZoneintegerOptional

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

ZipstringOptional

Customer zip code.

Errors