List customers
curl --request GET \
--url https://apigwuat.corpay.com/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://apigwuat.corpay.com/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apigwuat.corpay.com/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apigwuat.corpay.com/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apigwuat.corpay.com/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apigwuat.corpay.com/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apigwuat.corpay.com/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"customers": [
{
"customerAccountNumber": "1234567890",
"customerAddress": {
"addressLines": "123 Main Street Apt 4B",
"city": "London",
"country": "United Kingdom",
"countryCode": "GBR",
"region": "Greater London",
"zipCode": "AB12 3CD"
},
"customerBusinessReference": "123444",
"customerContact": {
"emailAddress": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"middleName": "A",
"mobilePhone": "+447700900123",
"telephone": "+441234567890"
},
"customerName": "John Doe",
"status": "Active",
"statusIdentifier": 1,
"countOfSubAccounts": 2,
"parentCustomerAccountNumber": "980000000",
"parentCustomerIdentifier": 3211
}
],
"hasNextPage": true,
"lastPage": true,
"nextCursor": "12131",
"totalCount": 100
}{
"errorCode": "ER-001",
"errorDescription": "Invalid request parameters"
}{
"errorCode": "ER-012",
"errorDescription": "The server encountered an unexpected condition and could not complete the request. Please contact Corpay Support."
}Customer
List customers
List subaccounts under the top-level account with pagination.
GET
/
customers
List customers
curl --request GET \
--url https://apigwuat.corpay.com/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://apigwuat.corpay.com/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apigwuat.corpay.com/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apigwuat.corpay.com/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apigwuat.corpay.com/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apigwuat.corpay.com/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apigwuat.corpay.com/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"customers": [
{
"customerAccountNumber": "1234567890",
"customerAddress": {
"addressLines": "123 Main Street Apt 4B",
"city": "London",
"country": "United Kingdom",
"countryCode": "GBR",
"region": "Greater London",
"zipCode": "AB12 3CD"
},
"customerBusinessReference": "123444",
"customerContact": {
"emailAddress": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"middleName": "A",
"mobilePhone": "+447700900123",
"telephone": "+441234567890"
},
"customerName": "John Doe",
"status": "Active",
"statusIdentifier": 1,
"countOfSubAccounts": 2,
"parentCustomerAccountNumber": "980000000",
"parentCustomerIdentifier": 3211
}
],
"hasNextPage": true,
"lastPage": true,
"nextCursor": "12131",
"totalCount": 100
}{
"errorCode": "ER-001",
"errorDescription": "Invalid request parameters"
}{
"errorCode": "ER-012",
"errorDescription": "The server encountered an unexpected condition and could not complete the request. Please contact Corpay Support."
}Performance expectations:
p50: 450 ms, p99: 1200 ms.
Measured on successful requests (2xx), server-side only.
How to interpret these metrics
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:
curl --location '<BASE_URL>/keycloak/realms/longship/protocol/openid-connect/token' \
--header 'accept: application/json' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=.......' \
--data-urlencode 'client_secret=......'
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.