Card Issue

Goal: issue a virtual card for an existing cardholder or user. Issuance fees are charged when the order is created.

Review the encrypted request rules in Overview before starting.

Workflow steps

  1. Create the card order

    Provide product_code (or legacy product_id) and external_user_id. Include the Idempotency-Key header.

  2. Track the order

    Poll until order.status is completed or failed.

  3. Fetch card data (optional)

    Retrieve the newly issued card details if you need them immediately.

API Endpoints

  • POST/api/v1/cards/createCreate the card issue order.
  • POST/api/v1/orders/checkTrack the order status and issue progress.
  • POST/api/v1/cards/getFetch card data after the order completes.

Schemas

CardIssueOrder

FieldTypeRequiredDescription
order_id
stringRequiredOrder identifier.
order_type
stringRequiredOrder type (card_issue, card_topup, etc.).
status
stringRequiredOverall order status. Enum: new, activating, processing, completed, failed
card_id
stringOptionalRelated card identifier, if applicable.
balance_before
stringOptionalProject balance before this order (decimal string).
balance_after
stringOptionalProject balance after this order (decimal string).
last_error
stringOptionalLast error message when status is failed.
last_error_slug
stringOptionalMachine-readable error code.
data
objectRequiredOrder-specific data payload.
created_at
stringRequiredOrder creation time (ISO 8601).
completed_at
stringOptionalCompletion time (ISO 8601).
failed_at
stringOptionalFailure time (ISO 8601).
issue_status
stringOptionalSub-status for card issuance. Enum: card_create_pending, card_create_done, card_create_error, initial_topup_pending, initial_topup_in_progress, initial_topup_error, initial_topup_done, initial_topup_verify_error, initial_topup_skipped, completed
is_issued
booleanOptionalWhether the card is issued successfully.
provider_card_status
stringOptionalProvider-level status string.

Error table

These are the most common error slugs when issuing cards.

Error SlugDescription
idempotency_key_requiredMissing Idempotency-Key header.
external_user_id_requiredexternal_user_id is required.
product_not_foundCard product not found.
product_not_activeCard product is not active.
cardholder_not_foundCardholder not found.
cardholder_not_readyCardholder is not ready for issuance.
insufficient_fundsMaster balance is too low for issue fees.
invalid_pricingPricing rules are misconfigured.
card_product_limits_invalidCard product limits are invalid.