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
  • 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
      • 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
    • Initiate card replacement
    • Verify OTP and complete card replacement
  1. Management

Get card

GET
https://api.staging.vrtx.sa/cards/{id}
Last modified:2025-12-03 10:51:05
Retrieves a card by its unique identifier, including status, token, last four digits,
and lifecycle timestamps.
Card Status Values:
UNSPECIFIED
ACTIVE
INACTIVE
CANCELLED
Error Responses (only these codes are returned):
400 INVALID_INPUT
403 ACCOUNT_NOT_ELIGIBLE
404 CARD_NOT_FOUND
409 CARD_LIMIT_REACHED
503 SERVICE_UNAVAILABLE

Request

Path Params

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 --location --request GET 'https://api.staging.vrtx.sa/cards/'

Responses

🟢200OK
application/json
Default Response
Body

Examples
{
    "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
🟠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
Verify card conversion OTP
Next
Change card status
Built with