Set or update card PIN

POST

https://api.staging.vrtx.sa/cards/set-pin

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

Initiates a PIN update for the specified card. When OTP verification is required, a
pin_set_operation_id is returned for downstream verification.

Request

Header Params

Body Params application/jsonRequired

Examples

example1example2

{
    "card_id": "f5a4b3c2-d1e0-9876-5432-1a0b9c8d7e6f",
    "new_pin": "1234",
    "confirmed_new_pin": "1234"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

example1example2

curl --location --request POST 'https://api.staging.vrtx.sa/cards/set-pin' \
--header 'idempotency-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "card_id": "f5a4b3c2-d1e0-9876-5432-1a0b9c8d7e6f",
    "new_pin": "1234",
    "confirmed_new_pin": "1234"
}'

Responses

🟢200OK

application/json

Default Response

Body

Examples

example1example2

{
    "card_id": "f5a4b3c2-d1e0-9876-5432-1a0b9c8d7e6f",
    "pin_set_operation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "requires_otp": true
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🟠409Conflict

🟠410Gone

🟠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

Change card status

Verify card PIN OTP