Skip to main content
POST
/
cardholders
/
{id}
/
suspend
Suspend a cardholder
curl --request POST \
  --url https://api.fyatu.com/api/v3.20/cardholders/{id}/suspend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Suspected fraudulent activity"
}
'
import requests

url = "https://api.fyatu.com/api/v3.20/cardholders/{id}/suspend"

payload = { "reason": "Suspected fraudulent activity" }
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({reason: 'Suspected fraudulent activity'})
};

fetch('https://api.fyatu.com/api/v3.20/cardholders/{id}/suspend', 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://api.fyatu.com/api/v3.20/cardholders/{id}/suspend",
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([
'reason' => 'Suspected fraudulent activity'
]),
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://api.fyatu.com/api/v3.20/cardholders/{id}/suspend"

payload := strings.NewReader("{\n \"reason\": \"Suspected fraudulent activity\"\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://api.fyatu.com/api/v3.20/cardholders/{id}/suspend")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Suspected fraudulent activity\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.fyatu.com/api/v3.20/cardholders/{id}/suspend")

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 \"reason\": \"Suspected fraudulent activity\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "status": 200,
  "message": "Cardholder suspended",
  "data": {
    "cardholderId": "chl_01HXYZ1234ABCDEF5678",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com",
    "status": "SUSPENDED",
    "kycStatus": "APPROVED",
    "suspendedAt": "2026-05-20T14:00:00Z",
    "totalCards": 2,
    "createdAt": "2026-05-01T09:00:00Z",
    "updatedAt": "2026-05-20T14:00:00Z"
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-20T14:00:00Z"
  }
}

Overview

Suspends an active cardholder. While suspended, all cards issued to the cardholder are immediately blocked — transactions will be declined at the network level. Suspension is reversible via POST /cardholders/{id}/reactivate.

Path Parameters

ParameterTypeDescription
idstringThe cardholder ID (prefix chl_)

Request Body (optional)

FieldTypeConstraintDescription
reasonstringMax 500 charactersInternal reason for suspension (not shown to cardholder)
An empty body {} is also valid — reason is optional.

Example

curl -X POST https://api.fyatu.com/api/v3.20/cardholders/chl_01HXYZ1234ABCDEF5678/suspend \
  -H "Authorization: Bearer $FYATU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "Flagged by fraud engine — pending review" }'
const resp = await fetch(
  'https://api.fyatu.com/api/v3.20/cardholders/chl_01HXYZ1234ABCDEF5678/suspend',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.FYATU_API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ reason: 'Flagged by fraud engine — pending review' })
  }
);
const body = await resp.json();
console.log(body.data.status);      // "SUSPENDED"
console.log(body.data.suspendedAt); // "2026-05-22T10:00:00Z"
import os, requests

resp = requests.post(
    'https://api.fyatu.com/api/v3.20/cardholders/chl_01HXYZ1234ABCDEF5678/suspend',
    headers={'Authorization': f'Bearer {os.environ["FYATU_API_KEY"]}'},
    json={'reason': 'Flagged by fraud engine — pending review'}
)
cardholder = resp.json()['data']
print(cardholder['status'])      # SUSPENDED
print(cardholder['suspendedAt'])

Success Response (200)

Returns the full updated cardholder object with status: SUSPENDED:
{
  "success": true,
  "status": 200,
  "message": "Cardholder suspended",
  "data": {
    "cardholderId": "chl_01HXYZ1234ABCDEF5678",
    "programId":    "prg_01HXYZ9876ABCDEF0000",
    "firstName":    "John",
    "lastName":     "Smith",
    "email":        "john.smith@example.com",
    "status":       "SUSPENDED",
    "kycStatus":    "APPROVED",
    "kycVerifiedAt": "2026-05-01T09:05:00Z",
    "suspendedAt":  "2026-05-22T10:00:00Z",
    "totalCards":   2,
    "totalSpendCents": 125000,
    "createdAt":    "2026-05-01T09:00:00Z",
    "updatedAt":    "2026-05-22T10:00:00Z"
  },
  "meta": {
    "requestId": "req_01HXY123456ABCDEF",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-22T10:00:00Z"
  }
}

Webhook

A CARDHOLDER_SUSPENDED event fires immediately after a successful suspension:
{
  "event":      "CARDHOLDER_SUSPENDED",
  "eventId":    "evt_01HXY123456ABCDEF",
  "businessId": "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":  "2026-05-22T10:00:00Z",
  "data": {
    "cardholderId": "chl_01HXYZ1234ABCDEF5678",
    "status":       "SUSPENDED",
    "suspendedAt":  "2026-05-22T10:00:00Z"
  }
}

Error Codes

CodeHTTPCause
ALREADY_SUSPENDED409Cardholder is already suspended
CARDHOLDER_TERMINATED409Terminated cardholder cannot be suspended
CARDHOLDER_NOT_FOUND404Cardholder does not exist or belongs to another business
VALIDATION_ERROR422reason exceeds 500 characters
INSUFFICIENT_SCOPE403Key lacks cardholders:write scope

Authorizations

Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Path Parameters

id
string
required

Body

application/json
reason
string
Example:

"Suspected fraudulent activity"

Response

Cardholder suspended

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Cardholder retrieved"

data
object
meta
object