Convert virtual to physical

POST

https://api.staging.vrtx.sa/cards/convert-to-physical

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

Converts a virtual card to a physical card. This initiates the conversion process and sends an OTP
to the customer's registered mobile number. The response includes a session ID that must be used
to complete the conversion via the complete conversion endpoint.

Request:

card_id: UUID of the virtual card to convert

idempotency-key header: UUID to ensure idempotency of the request

city: Delivery city for the physical card

Response:

session_id: Session ID (cardIssuanceId) to use for completing the conversion

Error Responses:

400 INVALID_INPUT: Invalid request body or parameters

400 INVALID_CITY: Invalid city provided

404 CARD_NOT_FOUND: Card does not exist

409 CARD_TYPE_CONFLICT: Card is already a physical card

412 CARD_STATUS_NOT_ALLOWED: Card is not in ACTIVE status

412 INVALID_CARD_STATUS: Card status is invalid for this operation

503 SERVICE_UNAVAILABLE: Service temporarily unavailable

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304",
    "city": "string"
}

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/convert-to-physical' \
--header 'idempotency-key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304",
    "city": "string"
}'

Responses

🟢200OK

application/json

Default Response

Body

Example

{
    "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠405Method Not Allowed

🟠409Conflict

🟠410Gone

🟠412Precondition Failed

🟠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

Verify card issuance OTP

Verify card conversion OTP