Card Status Change

Goal: freeze or unfreeze cards and confirm the new provider status.

Review the encrypted request rules in Overview before starting.

Workflow steps

  1. Freeze or unfreeze

    Provide card_id and external_user_id.

  2. Track order and card status

    Poll order status and then verify the card state.

API Endpoints

  • POST/api/v1/cards/freezeFreeze an active card.
  • POST/api/v1/cards/unfreezeUnfreeze a frozen card.
  • POST/api/v1/orders/checkTrack the status change order.
  • POST/api/v1/cards/getConfirm the updated card status.

Schemas

OrderBase

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).

CardStatus

FieldTypeRequiredDescription
card_id
stringRequiredCard identifier.
status
stringRequiredCurrent card status. Enum: pending_order, paid, pending_activation, wait_for_topup_activation_by_user, active, frozen, closed

Error table

These error slugs are common when changing card status.

Error SlugDescription
external_user_id_requiredexternal_user_id is required.
invalid_card_idCard identifier is invalid.
card_not_foundCard not found.
cardholder_not_foundCardholder not found.
card_issue_not_completedCard issue order is not completed yet.
invalid_card_statusCard status does not allow the requested action.
provider_invalid_card_statusProvider reported an unexpected status.
provider_errorProvider-specific failure.