Please try searching something.
Cards
Learn how to receive and/or update cards and card information using DECTA API
The Card Information request allows users to receive a list of client cards. This request returns partial information about cards; if the user needs to receive detailed information about a certain card, please use a specific GET card request. Some use cases might require that the cardholder change their PIN number or passphrase, or even replace a stolen or lost card and, if necessary, update their delivery address.
Get Cards
When you want to retrieve information about all your issued cards, you should use the request GET/v1/api/cards
to get a list of cards with detailed information.
Retrieve Card information
To receive detailed information about a specific card and client, use the request GET/v1/api/cards/{ppan}
and select necessary PPAN.
Retrieve Card data 1
Use request GET/v1/api/cards/{ppan}/card-data1
to get sensitive card information, like PIN code for a specific PPAN. DECTA takes data security seriously, so please contact your DECTA Manager to learn more about the availability of this additional feature.
Retrieve Card data 2 and 5
Use the request GET/v1/api/cards/{ppan}/card-data2
or GET/v1/api/cards/{ppan}/card-data5
to get sensitive card information, like full PAN and CVV2 or CVC2 for a specific PPAN. DECTA takes data security seriously, so please contact your DECTA Manager to learn more about the availability of this additional feature.
Retrieve Card data 3
If you are cooperating with a token service provider, you should use request GET/v1/api/cards/{ppan}/card-data3
to get selected card data including a clear pan, cardholder name, and expiry date to send to the token service provider.
Retrieve Card data 4
If you are cooperating with a third-party data service provider, you should use the request GET/v1/api/cards/{ppan}/card-data4
to get selected card data including a clear pan, cardholder name, and expiry date for the third-party data service provider.
Get a One-Time Password (OTP)
To keep the data transfer safe with token service provider, you will be required to use a OTP. To get it make the request GET/v1/api/cards/{ppan}/otp-secret
Assign PIN code
You have the option to offer your clients the possibility to change their PIN code by using the request POST/v1/api/cards/{ppan}/assign-pin
. The PIN code length is 4 digits. To find out more about this option and how you can start using it, contact your Account Manager.
Replace a card
When your client needs to replace a damaged or stolen/lost card, use the request POST/v1/api/cards/{ppan}/replace
. The clients previous card should be permanently blocked.
Renew a card
When your client needs to renew the plastic card that expires within 2 months use the request POST/v1/api/cards/{ppan}/renew
. This request allows to mark the card by selected PPAN which should be renewed and included in embossing file during the next file generation session. This request is intended only for plastic cards which are in status UNBLOCKED
or BLOCKED_BY_HOLDER
. If the card is in status BLOCKED_BY_HOLDER
, then it will be automatically changed to status UNBLOCKED
and marked for renewal. Use PATCH/v1/api/cards/{ppan}/state
to set again BLOCKED_BY_HOLDER
for the old card.
Renewed cards are made with the same account and card conditions configured in card product setting using the same PAN or a new PAN.
For renewed cards with the same PAN:
- The old card should be used until it expires and then the renewed card can be activated;
- Card token is updated.
- CVV/CVC is updated.
For renewed cards with a new PAN:
- The old card can be closed any time upon activating the renewed card;
- Card token is updated.
- CVV/CVC is updated.
Card Status Change
To change the card status, you should request PATCH/v1/api/cards/{ppan}/state
that allows to activate, block or unblock a card by selected pseudo-pan.
Activate Card
To activate a physical card that has been received by the cardholder and has the status 1- Suspended, make a PATCH/v1/api/cards/{ppan}/state
request and set the state to ACTIVE
. In this request the cardholder should indicate the last 6 digits of the card.
Suspend Card
To suspend a card make a PATCH/v1/api/cards/{ppan}/state
request and set the state to BLOCKED_BY_HOLDER
or BLOCKED_BY_PARTNER
. A suspended card can still be unblocked or blocked permanently.
Card statuses with converted card blocking reason codes to Visa/Mastercard systems:
Card status via DAPI function | ISO reason code (Authorisation response code) | Converted reason code to Visa | Converted reason code to Mastercard | Description |
---|---|---|---|---|
BLOCKED_BY_HOLDER | 104 (decline, do not honor) | 78 | 62 | Selected card is temporarily blocked, possible to unblock |
BLOCKED_BY_PARTNER | 107 (decline, refer to card issuer) | 57 | 01 | Selected card is temporarily blocked, possible to unblock |
Reactivate Suspended Card
To activate a card that was suspended, make a PATCH/v1/api/cards/{ppan}/state
request and set the state to UNBLOCKED
.
Card Closure
Closing a card is equal to blocked permanently card status and can’t be reversed. Make PATCH/v1/api/cards/{ppan}/state
request and set the state to BLOCKED_PERMANENTLY
or BLOCKED_TERMINATED
or BLOCKED_NOT_RECEIVED
.
Card statuses with converted card blocking reason codes to Visa/Mastercard systems:
Card status via DAPI function | ISO reason code (Authorisation response code) | Converted reason code to Visa | Converted reason code to Mastercard | Description |
---|---|---|---|---|
BLOCKED_PERMANENTLY | 203 (pick-up, card acceptor contact card acquirer) | 04 | 04 | Selected card is blocked forever for any reason, not possible to unblock |
BLOCKED_TERMINATED | 204 (pick-up, restricted card) | 46 | 04 | Selected card is blocked forever due to agreement termination with the client, not possible to unblock |
BLOCKED_NOT_RECEIVED | 208 (pick-up, lost) | 41 | 41 | Selected card is blocked forever because the plastic card is not received/ lost, not possible to unblock |
Jump to
- Get Cards
- Retrieve Card information
- Retrieve Card data 1
- Retrieve Card data 2 and 5
- Retrieve Card data 3
- Retrieve Card data 4
- Get a One-Time Password (OTP)
- Assign PIN code
- Replace a card
- Renew a card
- Card Status Change
- Activate Card
- Suspend Card
- Reactivate Suspended Card
- Card Closure