Skip to main content
POST
/
customers
/
subcustomer
Create sub customer
curl --request POST \
  --url https://apigwuat.corpay.com/customers/subcustomer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerName": "<string>",
  "customerContact": {
    "emailAddress": "jsmith@example.com",
    "firstName": "<string>",
    "lastName": "<string>",
    "middleName": "<string>",
    "mobilePhone": "<string>",
    "telephone": "<string>"
  },
  "customerAddress": {
    "addressLines": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "region": "<string>",
    "zipCode": "<string>"
  },
  "customerAccountNumber": "<string>",
  "customerBusinessReference": "<string>"
}
'
{
  "customerAccountNumber": 50000002122
}

Documentation Index

Fetch the complete documentation index at: https://api.corpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Performance expectations:
p50: 250 ms, p99: 800 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.

UAT token endpoint: POST https://apigwuat.corpay.com/keycloak/realms/longship/protocol/openid-connect/token

Example:

curl --location 'https://apigwuat.corpay.com/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=......'

Body

application/json
​
customerName
string
required
Maximum string length: 310
​
customerContact
object
required
​
customerAddress
object
required

If customer address is provided then all the fields inside the address object needs to be provided.

​
customerAccountNumber
string
​
customerBusinessReference
string
Maximum string length: 40

Response

Subcustomer's customer account number

​
customerAccountNumber
string