1. Management
Vrtx Docs
  • Welcome đź‘‹
  • Get Started
  • Auth
    • Token
      POST
  • Onboarding
    • Start onboarding
      POST
    • Verify onboarding OTP
      POST
    • Resend onboarding OTP
      POST
    • Get session status
      GET
    • Initiate Nafath
      POST
    • Cancels session
      POST
    • Complete customer info
      POST
  • Wallet
    • Change mobile number from profile settings
      • Change mobile number
      • Verify mobile number change OTP
      • Get mobile change status
    • Change mobile number from login screen
      • Change mobile number
      • Verify mobile number change OTP
      • Initiate Nafath
      • Get mobile number change status
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get batch report
      GET
  • Cards
    • Issuance
      • Replace card
      • Verify replace card OTP
      • Issue card
      • Get card issuance
      • Complete card issuance
      • Verify card issuance OTP
      • Convert virtual to physical
      • Verify card conversion OTP
    • 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
  • Transactions
    • Business Accounts
      • Get business account balance
      • Get transaction details
      • List business transactions
    • Wallet Accounts
      • Get wallet balance
      • List wallet transactions
  • cards
  • cards
    • Initiate card replacement
    • Verify OTP and complete card replacement
Open-Loop-v2
Closed-loop V2Card Simulatoropen-loop-test
Open-Loop-v2
Closed-loop V2Card Simulatoropen-loop-test
  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

Responses

🟢200OK
application/json
Default Response
Body

đźź 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
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"
}'
Response Response Example
200 - example1
{
    "card_id": "f5a4b3c2-d1e0-9876-5432-1a0b9c8d7e6f",
    "pin_set_operation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "requires_otp": true
}
Modified at 2025-12-03 10:51:05
Previous
Change card status
Next
Verify card PIN OTP
Built with