Skip to main content
GET
Get a customer
Performance expectations:
p50: 170 ms, p99: 600 ms.
Measured on successful requests (2xx), server-side only.
How to interpret these metrics

Authorizations

Authorization
string
header
required

Use OAuth2 client credentials to obtain a bearer token.

Token endpoint: POST <BASE_URL>/keycloak/realms/longship/protocol/openid-connect/token

Use the same base URL as the selected API server:

  • Test environment: https://apigwuat.corpay.com
  • Production environment: https://apigw.corpay.com

Example:

Path Parameters

customerAccountNumber
string
required

Response

Customer

customerAccountNumber
string
required
customerName
string
required
status
string
required
customerAddress
object
customerBusinessReference
string

Reference to Consumer System Internal Identifier

customerContact
object
statusIdentifier
integer

Identifier of the customer's current status.

countOfSubAccount
integer

Number of direct subaccounts of this customer.

parentCustomerAccountNumber
string

Account number of the customer's parent account.

parentCustomerIdentifier
integer

Internal identifier of the customer's parent account.