vrtx Docs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
  1. Management
  • Issuance
    • Issue card
      POST
    • Get card issuance
      GET
    • Complete card issuance
      POST
    • Verify card issuance OTP
      POST
    • Convert virtual to physical
      POST
    • Verify card conversion OTP
      POST
  • Management
    • Get card
      GET
    • Change card status
      PATCH
    • Set or update card PIN
      POST
    • Verify card PIN OTP
      POST
    • Activate physical card
      POST
    • Verify activation OTP
      POST
    • Display sensitive data
      POST
    • Verify display sensitive data OTP
      POST
  1. Management

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
{
    "card_id": "f5a4b3c2-d1e0-9876-5432-1a0b9c8d7e6f",
    "new_pin": "1234",
    "confirmed_new_pin": "1234"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
cURL
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
{
    "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
Previous
Change card status
Next
Verify card PIN OTP
Built with