Skip to main content

Audience:

DevelopersOperators

Digital card statuses

The lifecycle of a digital card, from provisioning to cancelation. For the model behind the flow, refer to digital cards.

Statuses

The API splits digital card statuses across two enums, depending on how far the digitization has progressed: PendingDigitalCardStatus (returned in PendingDigitalCard.statusInfo) covers the provisioning phase, and CompleteDigitalCardStatus (returned in CompleteDigitalCard.statusInfo) covers the card's life after provisioning.

Provisioning phase (PendingDigitalCardStatus)

Digital card statusExplanation
ConsentPendingRequest to add a digital card was sent with the addDigitalCard or addDigitalCards mutation and is waiting for the cardholder's consent.

Next steps:
  • If the cardholder consents, the status moves to Pending.
  • If the cardholder doesn't consent, the status moves to Canceled.
  • If you use the API to cancel the card, the status moves to Canceled.
PendingCardholder added the card to their digital wallet manually, or they provided consent after you added the card with the API.

Next steps:
  • If the card is added to their wallet successfully, the status moves to Enabled.
  • If the card is declined during provisioning, the status moves to Declined.
  • If the card is canceled during provisioning, the status moves to Canceled.
  • You can use the activateDigitalCard mutation to help complete the provisioning process.
DeclinedCard was declined during the provisioning process.

After provisioning (CompleteDigitalCardStatus)

Digital card statusExplanation
EnabledDigital card is available for use.

Next steps:
  • Cards can retain the status Enabled indefinitely.
  • Enabled cards can also be Suspended and Canceled.
SuspendedDigital card is suspended and not available for use.

Cards can be suspended for various reasons, including a request from you or the cardholder, or a Swan action in the case of suspicious activity.

Next steps:
  • Restore the card's previous status with the API.
  • Cancel the card with the API.
CanceledCard is canceled, no longer available for use, and can't be reactivated.
Transitioning from manual to in-app provisioning

If a digital card is stuck in Pending status after manual provisioning (for example, the cardholder didn't complete OTP verification), you can use the activateDigitalCard mutation to help them complete the process without restarting. Learn more in the transitioning from manual to in-app provisioning guide.