Skip to main content
POST
/
customers
/
{customerAccountNumber}
/
block
Block a customer
curl --request POST \
  --url https://apigwuat.corpay.com/customers/{customerAccountNumber}/block \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "<string>"
}
'
{
  "$ref": "#/components/schemas/Status/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: 1200 ms, p99: 1800 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=......'

Path Parameters

​
customerAccountNumber
string
required

Body

application/json
​
notes
string
Maximum string length: 200

Response

Operation status

The response is of type object.