Unlock a card

Unlock a card by the Helix-assigned cardId.

This action can be reversed by calling /card/lock.

The following matrix details when this call will succeed or fail.

Current lockTypeCodeCurrent lockReasonTypeCodeResult
CSTUNK - UnknownSuccess
CSTDMG - Physical DamageSuccess
CSTTMP - TemporarySuccess
CSTADM - AdministrativeSuccess
CSTLST - LostFail — Lost cards can never be used again
CSTSTL - StolenFail — Stolen cards can never be used again
CSTFRD - Suspected FraudFail — Suspected Fraud cards can never be used again
SYSLST - LostFail — Lost cards can never be used again
SYSSTL - StolenFail — Stolen cards can never be used again
SYSFRD - Suspected FraudFail — Suspected Fraud cards can never be used again
SYSADM - AdministrativeFail — Only Admin Console or an automated process can unlock
SYSPIN - PIN Retry Limit ExceededFail — Only Admin Console or an automated process can unlock
SYSTMP - TemporaryFail — Only Admin Console or an automated process can unlock

Result of a Successful Unlock

If the call succeeds:

  • The card will have a lockTypeCode of UNL.
  • The card will be unlocked.
  • The card will be ready for transactions.
Body Params
int32
required
≥ 1
int32
required
≥ 1
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json