Verify card PIN OTP

POST

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

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

Verifies the OTP returned from the set PIN initiation flow and finalises the card PIN update.
Requires the pin_set_operation_id reference returned earlier.
Error Responses:

400 INVALID_OTP_FORMAT - OTP format is invalid (must be 4 digits)

400 OTP_EXPIRED - OTP has expired. Please initiate a new operation.

400 OTP_MAX_ATTEMPTS_REACHED - Maximum OTP verification attempts reached. Please initiate a new operation.

400 OTP_VERIFICATION_FAILED - OTP verification failed (generic error)

400 OTP_INVALID - Invalid OTP provided. Please try again.

404 CARD_NOT_FOUND - The card is invalid. Please use a valid card.

404 OTP_OPERATION_NOT_FOUND - The operation ID is invalid. Please use a valid operation.

422 OTP_OPERATION_WRONG_STATUS - OTP operation is not in correct state (already completed or failed)

503 SERVICE_UNAVAILABLE - The service is currently unavailable. Please try again later.

Request

Body Params application/jsonRequired

Example

{
    "pin_set_operation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "otp": "1234"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/cards/set-pin/verify-otp' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pin_set_operation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "otp": "1234"
}'

Responses

🟢200OK

application/json

Default Response

Body

Example

{
    "pin_set_operation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

🟠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

Set or update card PIN

Activate physical card