Skip to main content
POST
/
cards
/
statusUpdate
Register for card status updates
curl --request POST \
  --url https://apigwuat.corpay.com/cards/statusUpdate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cardIdentifier": 123,
  "target_url": "<string>",
  "hmac_enabled": true,
  "hmac_secret": "<string>",
  "max_retries": 123
}
'
{
  "status": "created",
  "integration_key": "corpay.gfn.cards.statusUpdate.cardIdentifier.123426",
  "webhook_id": "744317f9-ca90-4388-bb00-f2a10f1db627"
}

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.

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
ā€‹
cardIdentifier
integer
required
ā€‹
target_url
string
required

url for the system where webhook should respond to in case of event.

ā€‹
hmac_enabled
boolean
ā€‹
hmac_secret
string
ā€‹
max_retries
integer

Response

created

ā€‹
status
string
ā€‹
integration_key
string
ā€‹
webhook_id
string