Initiate card replacement

Initiates card replacement for an active card. This cancels the old card and creates a new one
with a new PAN, token, and expiry date. The replacement inherits the original card's type
(virtual or physical).

Request:

card_id: UUID of the card to replace

city: Delivery city (required for physical cards)

replacement_reason: Optional reason for replacement (LOST, STOLEN, OTHER)

idempotency-key header: Required for request deduplication

Response:

session_id: Session ID to use for OTP verification

Flow:

Call this endpoint to initiate replacement (sends OTP)

Call /cards/replacement/verify-otp with the session_id and OTP to complete

Error Responses:

400 INVALID_INPUT: Invalid request body or parameters

400 INVALID_CITY: Invalid city provided (required for physical cards)

404 CARD_NOT_FOUND: Card does not exist

412 INVALID_CARD_STATUS: Card is not in ACTIVE status

503 SERVICE_UNAVAILABLE: Service temporarily unavailable

503 INVALID_CARD: Card replacement failed (Paymentology error)

Responses

🟢200OK

application/json

Default Response

Body

🟠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

curl --location --request POST 'https://api.staging.vrtx.sa/cards/replacement' \ --header 'idempotency-key;' \ --header 'Content-Type: application/json' \ --data-raw '{ "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304", "city": "string", "replacement_reason": "LOST" }'