Block Card API is called by the client to block the card on different aspects, there are majorly six types as described in the following table:
| Block Type | Description |
|---|---|
| Custom | Card will Custom Blocked (partial transactions will be allowed) |
| Temporary | Card will be Temporary Blocked (No transactions will be permitted) |
| Permanent | Card is Permanently Blocked |
| Debit | All debits from the card will be blocked (except system debits(source Account type – 11, 12, 15, 16, 41, 42)) |
| Credit | All credits to the card will be blocked (except system credits(source Account type – 11, 12, 15, 16, 41, 42)) |
| CreditDebit | All Credits and Debits will not allow, except system reversal credits and debits |
Environment: https://domain/mob1/api/onboarding /v1/block
HTTP Method: PATCH
Note:
Domain will be shared once this move to respective environment.
Request parameters
Header
| Parameter | Description | Example |
|---|---|---|
| x-api-key mandatory | String This is a unique key. | 7fe1c0de |
| clientId mandatory | String Uniquely identifies the client. During program enrolment each client is provided with a unique client id by Prepaid | 2000 |
| bankId mandatory | Numeric Bank Id is provided by Prepaid Aero during program enrolment to uniquely identify the card issuer. | 7000 |
| entityId mandatory | Numeric Defaults to parent branch i.e., 100 | 100 |
| secureCode mandatory | String Uniquely identifies the client on payload level for performing operations. | AfYtlO5kqdySIjXyNmGg3F |
Body
Sample request
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
}
Packet sample (Decrypted)
{
"messageCode": "1240",
"clientTxnId": "CBL-458", "requestDateTime": "20161011221416", "last4Digits": "1559",
"urn": 70000000008,
"blockType": "CreditDebit", "customerId":"IN00001201001865", "reserved1":"Block",
"reserved2":"mobile lost.Blocking the card"
}
Response parameters
API error codes
| Error Code | Description |
|---|---|
| 00 | SUCCESS |
| 1001 | CARD NOT FOUND |
| 1009 | CARD CANCELLED CLOSED EXPIRED |
| 1010 | CARD TEMPORARY BLOCK |
| 1011 | CARD PERMANENT BLOCK |
| 1012 | CARD PENDING CANCELLATION |
| 1030 | INVALID MESSAGE |
| 1034 | INVALID_MOBILE_NUMBER |
| 1045 | UNABLE TO PROCESS REQUEST |
| 1112 | INVALID BLOCK TYPE |
| 1117 | CARD DEBIT BLOCK |
| 1118 | CARD CREDIT BLOCK |
| 1121 | CARD CREDIT DEBIT BLOCK |
| 1131 | CARD CUSTOM BLOCK |
| 1231 | DATA_NOT_FOUND |
| 1237 | DUPLICATE_PHONE_NUMBER_WITH_MULTIPLE_ACCOUNT |
| 1356 | CARD_NOT_ACTIVE |
| 1366 | PROGRAM IS INACTIVE |
| 1367 | PROGRAM NOT FOUND |
HTTP status code
| HTTP Status Code | HTTP Status Description |
|---|---|
| 200 | OK |
| 404 | Not Found |
| 500 | Internal Server Error |
| 403 | Forbidden |
| 400 | Bad Request |
| 401 | Unauthorized |
| 503 | Service Unavailable |
Sample response
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
}
Packet sample (Decrypted)
{
"urn": 70000000008, "customerId": "62508sree0061", "description": "[RESERVE_1]",
"responseCode": "00",
"messageCode": 1241,
"clientTxnId": "BLOCK_JM_aax11LrjoCV-f34", "clientId": "2000",
"responseDateTime": "20230615234800", "responseMessage": "SUCCESS",
"bankId": 7000,
"accosaRefNo": "52"
}Block Card API is called by the client to Block the Card on different aspects, there are majorly 6 types, Temporary Block, Custom Block, Permanent Block, Debit Block, Credit Block and CreditDebit Block.