Integrated status and states
Card status and state
Cross River defines several card statuses within COS that play a key role in how transactions are processed. These statuses help govern the card’s lifecycle and support important compliance and security policies.
Each status directly impacts whether a transaction is approved and what message is sent back to the card network during a transaction attempt. COS uses this status system to make sure cards are managed securely and accurately.
Card status also helps determine the overall card state.
COS assigns both statuses and states to cards to govern their behavior during authorization:
State changes are communicated via webhook events (such as Cards.Status.Changed) to keep partner systems in sync.
Card status
The status refers to the card’s activation level and whether the cardholder is allowed to use it. The card status also contributes to the card state.
The status attribute is the activation status of the card and if the card can be used by the cardholder:
- Unactivated - The card has not been activated by the cardholder
- Active - The card is active and ready for use
- Suspended - The card is currently suspended
- Closed - The card is closed
The orderStatus attribute is the current status of the order:
- Order Pending - The order is pending fulfillment by the processor
- Completed - The order has been fulfilled by the processor. For physical cards, the card is being printed and mailed to the cardholder
- Failed - The order failed at the processor level
The status of a newly created card is Unactivated and the order status is OrderPending. The order status updates to Completed when the order is complete. For physical cards, this means the card has been mailed to the customer.
Managing a card program may require you to update card statuses for specific scenarios. For example, you may want to offer your customers added security by allowing them to temporarily suspend a card that has been misplaced.
Update activated card status when necessary to suspend, block, or close a card:
- Suspended - Suspending a card temporarily inactivates it until you remove the suspension by activating the card again (unsuspending). The cardholder is allowed to remove this block.
- Refer to the suspend card and unsuspend a card APIs.
- Placed on administrative block - An administrative block means that the card is both suspended and has been blocked using the admin-block endpoint. Only an admin can remove this block.
- Refer to admin-block API.
- Closed
- Refer to the close card API.
IMPORTANT Once the card is closed, it cannot be reactivated.
Card states
A given card status can be due to more than one reason. For example, a card might be suspended because it was lost, stolen, or blocked due to fraud. Knowing the reason for a given status is important to manage the card life cycle. At Cross River we call combination of status and other attributes card state.
You see the card state in the Cards.Status.Changed webhook event.
You need to register to receive webhooks.
Card state | Card status | Other related fields and their values |
|---|---|---|
Card has never been Activated | Unactivated | |
Card Activated | Active | |
Card Closed | Closed | |
Card Lost | Suspended | StatusReasonCode = Lost |
Card Stolen | Suspended | StatusReasonCode = Stolen |
Admin Blocked | Suspended | AdminBlocked = true |
Fraud Blocked | Suspended | FraudSuspect = true StatusReasonCode = FraudBlocked |
Card Suspended by User | Suspended | StatusReasonCode = NotSet |
Card Unsuspended by User or Admin | Active | StatusReasonCode = NotSet FraudSuspect = false AdminBlocked = false |