Unblock card
This method unblocks a specified card. Unblocking a card is permitted only for cards in a "BLOCKED" state, and these cards must be associated with "ACTIVE" accounts. If a blocked card has associated card plastic, the card is set to the "ACTIVE" state; otherwise, it is set to "DIGITALLY ACTIVE."
Additionally, the process of unblocking a card is determined by user roles, which have the authority to unblock a specific reason code based on the level of the user role.
If the unblock request is made by "BANK” than all blocks with these codes can be lifted:
- "LOST"
- "STOLEN"
- "DETAINED"
- "BANK"
- "FRAUD"
- "BLOCKED_BY_ACCOUNT"
If unblock request is made by "ACCOUNT OWNER” than only blocks made by “ACCOUNT OWNER” or "HOLDER” with these codes can be lifted:
- "LOST"
- "STOLEN"
If unblock request is made by "HOLDER” than only blocks made by "HOLDER” with these codes can be lifted:
- "LOST"
- "STOLEN"
A card can be blocked by “BANK” and "ACCOUNT OWNER”/ "HOLDER”, if only one block is lifted than the card remains blocked. In addition, card can be simultaneously block for different reason codes.
As the card number needs to be simultaneously unblocked by the card processor, CMS sends a request to unblock the card number. Subsequently, the card number is allowed to authorize transactions again.
URL test:
URL live:
Method:
POST
Path items:
/cards (Card Service)
/{id} (ID code of unlocked card)
/unblock (Method name)
/{blockId} (Card block unique id from route)
Parameters:
| Parameter | Location | Type | Example | Description | Required |
|---|---|---|---|---|---|
| id | Path | integer | 265 | Internal Card ID | Yes |
| blockId | Path | string | "LOST" | Reason of block | Yes |
| x-cms-role | Header | string | "BANK" | Level of user role | Yes |
| requestedBy | Body | string | "BANK" | Level of user role | Yes |
Example:
curl -X 'POST' \
'https://dev.lightcms.io/cms/v1/cards/17/unblock/1' \
-H 'accept: */*' \
-H 'x-cms-role: BANK' \
-H 'Content-Type: application/json' \
-d '{
"requestedBy": "BANK"
}'
Responses:
200 - OK
Status Code: 200 OK
500 - Internal error
Status Code: 500 Internal error
400 - Card is not in blocked state
Status Code: 400 Bad request
| Parameter | Location | Type | Example | Description |
|---|---|---|---|---|
| errorMessage | body | string | "Card is not in blocked state." | Error message |
400 - Level of user mismatch
Status Code: 400 Bad request
| Parameter | Location | Type | Example | Description |
|---|---|---|---|---|
| errorMessage | body | string | "Requested as BANK, but requested in header HOLDER." | Error message |