Customer

Get customer record

Retrieves a customer's record and details.

get/Customer/{customerId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Customer/{customerId}
  • Auth: HTTP bearer

Path parameters

customerIdinteger required

Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.

Response

Success

customerIdinteger

The Payabli-generated unique ID for the customer.

customerNumberstring

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.

Emailstring email

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

The shipping address.

ShippingAddress1string

Additional line for shipping address.

ShippingCitystring

Shipping city.

ShippingStatestring

Shipping state or province.

ShippingZipstring

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.

Balancenumber double

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.

LastUpdatedstring date-time

Date and time of last update.

Createdstring date-time

Date and time created.

AdditionalFieldsobject

List of additional custom fields in format key:value.

IdentifierFieldsstring[]

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

PaypointLegalnamestring

Business legal name.

PaypointDbanamestring

The alternate or common name that this business is doing business under, usually referred to as a DBA name.

ParentOrgNamestring

The name of the parent organization.

ParentOrgIdinteger

The ID of the org's parent organization.

PaypointEntrynamestring

The entrypoint identifier.

pageidentifierstring

Auxiliary validation used internally by payment pages and components.

externalPaypointIDstring

A custom identifier for the paypoint, if applicable.

customerPortalstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.