List customers
List subaccounts under the top-level account with pagination.
p50: 450 ms, p99: 1200 ms.
Measured on successful requests (2xx), server-side only.
How to interpret these metrics
Authorizations
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:
Query Parameters
Limits the results to direct subaccounts of the specified customer account. If omitted, returns all descendants of the top-level account; the top-level account itself is never included.
Filters customers using a case-insensitive partial match against customerAccountNumber, customerName, or customerBusinessReference. When combined with customerAccountNumber, both filters are applied.