Change card status

PATCH

https://api.staging.vrtx.sa/cards/{id}/status

Last modified:2025-12-03 10:51:05

Updates the lifecycle status of an existing card. Use this endpoint to toggle between
ACTIVE, INACTIVE, or permanently CANCELLED states. The operation is idempotent and
requires an idempotency-key header to deduplicate requests.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

example1example2example3

{
    "status": "ACTIVE"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

example1example2example3

curl --location --request PATCH 'https://api.staging.vrtx.sa/cards//status' \
--header 'idempotency-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "ACTIVE"
}'

Responses

🟢200OK

application/json

Default Response

Body

Examples

example1example2

{
    "id": "f5a4b3c2-d1e0-9876-5432-1a0b9c8d7e6f",
    "account_id": "b2c3d4e5-f6a7-5890-b123-c4d5e6f7a8b9",
    "token": 987654321,
    "status": "LOCKED",
    "last_4_digits": "8765",
    "expiry_date": "2026-06-30",
    "design": "premium",
    "created_at": "2023-12-01T08:15:00Z",
    "updated_at": "2024-01-10T14:20:00Z",
    "is_physical": true,
    "physical_card_activation_status": "ACTIVATED",
    "physical_activated_at": "2024-02-01T09:00:00Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🟠409Conflict

🟠410Gone

🟠412Precondition Failed

🟠422Unprocessable Entity

🟠429Too Many Requests

🔴500Internal Server Error

🔴501Not Implemented

🔴503Service Unavailable

🔴504Gateway Timeout

🔴505HTTP Version Not Supported

Modified at 2025-12-03 10:51:05

Get card

Set or update card PIN