post https://sandbox-api.helix.q2.com/card/unlock
Unlock a card. Can be reversed by calling /card/lock. The following matrix details when this call will succeed or fail.
| Current lockTypeCode | Current lockReasonTypeCode | Result |
|---|---|---|
CST | UNK - Uknown | Success |
CST | DMG - Physical Damage | Success |
CST | TMP - Temporary | Success |
CST | ADM - Administrative | Success |
CST | LST - Lost | Fail - Lost cards can never be used again |
CST | STL - Stolen | Fail - Stolen cards can never be used again |
CST | FRD - Suspected Fraud | Fail - Suspected Fraud cards can never be used again |
SYS | LST - Lost | Fail - Lost cards can never be used again |
SYS | STL - Stolen | Fail - Stolen cards can never be used again |
SYS | FRD - Suspected Fraud | Fail - Suspected Fraud cards can never be used again |
SYS | ADM - Administrative | Fail - Only Admin Console or an automated process can unlock |
SYS | PIN - PIN Retry Limit Exceeded | Fail - Only Admin Console or an automated process can unlock |
SYS | TMP - Temporary | Fail - Only Admin Console or an automated process can unlock |
The card will have a lockTypeCode of UNL upon successful completion of this call. The card will be unlocked and ready for transactions to take place.
Error Codes
Click to expand
| Code | Message (en-US) | Notes |
|---|---|---|
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 150501 | Invalid CardId {0} or CustomerId {1}. | |
| 150502 | CardId {0} has been locked by an Administrator or an automated process. | |
| 150503 | CardId {0} has been marked as lost, stolen, or suspected fraudulent. Cannot unlock. | |
| 154101 | Invalid Card {0} or CustomerId {0} is not associated with the card. | |
| 154102 | Invalid Request |