Skip to main content
POST
/
cards
/
{cardIdentifier}
/
cancel
Cancel a card
curl --request POST \
  --url https://apigwuat.corpay.com/cards/{cardIdentifier}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "statusReasonId": 2,
  "notes": "Card cancelled by admin"
}
'
import requests

url = "https://apigwuat.corpay.com/cards/{cardIdentifier}/cancel"

payload = {
"statusReasonId": 2,
"notes": "Card cancelled by admin"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({statusReasonId: 2, notes: 'Card cancelled by admin'})
};

fetch('https://apigwuat.corpay.com/cards/{cardIdentifier}/cancel', 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/cards/{cardIdentifier}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'statusReasonId' => 2,
'notes' => 'Card cancelled by admin'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://apigwuat.corpay.com/cards/{cardIdentifier}/cancel"

payload := strings.NewReader("{\n \"statusReasonId\": 2,\n \"notes\": \"Card cancelled by admin\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://apigwuat.corpay.com/cards/{cardIdentifier}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"statusReasonId\": 2,\n \"notes\": \"Card cancelled by admin\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://apigwuat.corpay.com/cards/{cardIdentifier}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"statusReasonId\": 2,\n \"notes\": \"Card cancelled by admin\"\n}"

response = http.request(request)
puts response.read_body
{
  "$ref": "#/components/schemas/Status/example"
}
{
"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: 900 ms, p99: 2500 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.

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=......'

Path Parameters

cardIdentifier
integer
required

Body

application/json
statusReasonId
integer
required
notes
string
Maximum string length: 200

Response

Operation status

The response is of type object.