APIPay In endpointsCustomer

Get customer

View as MarkdownOpen in Claude
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
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.

customerUsernamestring
Username for customer.
customerStatusinteger

Customer Status. Possible values:

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

ShippingCountrystring
Shipping address country.
Balancedouble
Customer balance.
TimeZoneinteger

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

MFAboolean

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

MFAModeinteger
snProviderstring

Social network linked to customer. Possible values:

  • facebook

  • google

  • twitter

  • microsoft

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

List of additional custom fields in format key:value.

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

customerConsentobject

Errors

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