Skip to main content
POST
/
cards
/
search
Search cards
curl --request POST \
  --url https://apigwuat.corpay.com/cards/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 2,
  "cursor": "<string>",
  "sortExpression": "<string>",
  "customerAccountNumber": "<string>",
  "orderReference": "<string>"
}
'
{
  "$ref": "#/components/schemas/CardListResponse/example"
}

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: 220 ms, p99: 1900 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
limit
integer

Max number of records to return.

Required range: x >= 1
cursor
string

Pagination cursor from a previous response.

sortExpression
string

Sort expression, e.g., "createdAt desc".

customerAccountNumber
string

Customer account identifier.

orderReference
string

Order reference to filter by.

Response

Card results

cards
object[]
customerAccountNumber
string
hasNextPage
boolean
lastPage
boolean
nextCursor
string
totalCount
integer