The Change Card Status API will change the card status of the card number of the customer. Basically, we can activate the card from pre-active status using the change card status API.
Environment: https://domain/api/onboarding/v1/change-card-status
HTTP Method: PATCH
Request parameters
<WalletHeader />
Body
Note:
Encryption or decryption methodology is AES-192-CBC bits encryption.
Parameter | Description | Example |
---|---|---|
Encrypted | ||
token |
| Pl8F5kDZcvADIiursiA |
Decrypted | ||
messageCode |
| 1080 |
clientTxnId |
| GOUd789hhhjfscs |
urn |
| 70000000008 |
cardStatus |
| Active |
reason |
| Customer Activation |
Sample request
Packet sample (Encrypted)
{
“token”:"Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb1nSY6s="
}
Packet sample (Decrypted)
{
"messageCode": 3010,
"clientTxnId": "ChangecardStatus000001",
"requestDateTime": "20220615123143",
"urn": "70000000008",
"cardStatus": "Active"
}
Response parameters
Parameter | Description | Example |
---|---|---|
Encrypted | ||
token | Token is the Encrypted body of the below request AES-192-CBC bits Encryption | Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb1nSY6s= |
Decrypted | ||
messageCode | Code to Identity create card response type | 1011 |
clientTxnId | Value copied from the request | 20150701235959xhstiesqfds |
responseDateTime | Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format | 20161031214559 |
responseCode | Contains the status of the transaction. 201 indicates CREATED. Please refer Appendix for other response codes | 201 |
responseMessage | Response message based on response code will be sent | Card creation successful |
urn | A unique reference number for the generated card/wallet by Prepaid system | 70000000008 |
bankId | Value copied from request header | 7000 |
clientId | Unique ID for client | 2000 |
accosaRefNo | Auto generated sequence number. | 4565166 |
customerId | Customer ID generated by client stored against customer’s prepaid instrument. | IN2016201611 |
API error codes
Error Code | Description |
---|---|
1001 | CARD_NOT_FOUND |
1004 | CARD_ALREADY_ACTIVATED |
1009 | CARD CANCELLED CLOSED EXPIRED |
1010 | CARD_TEMPORARY_BLOCK |
1011 | CARD_PERMANENT_BLOCK |
1012 | CARD_PENDING_CANCELLATION |
1030 | INVALID MESSAGE |
1031 | INVALID BANK ID |
1032 | INVALID_CLIENT_CHANNEL |
1049 | INVALID SECURE CODE |
1051 | CHECKSUM FAILURE |
1052 | SYSTEM_ERROR |
1055 | MALFORMED_REQUEST |
1058 | INVALID WALLETS |
1080 | IP_NOT_ALLOWED |
1081 | OPERATION NOT ALLOWED |
1084 | CARD_CUSTOMER_ID_MISMATCH |
1085 | PRODUCT NOT ALLOWED |
1088 | INVALID DATE FORMAT |
1093 | INVALID CLIENT TXN ID |
1118 | CARD_CREDIT_BLOCK |
1121 | CARD_CREDIT_DEBIT_BLOCK |
1131 | CARD_CUSTOM_BLOCK |
1262 | CLIENT ID NOT PRESENT |
1264 | BANK ID NOT PRESENT |
1292 | CARD_STATUS_CANNOT_BE_BLANK |
1293 | INVAILD_CARD_STATUS |
1302 | INVALID_CUSTOMER |
1303 | CUSTOMER DETAILS NOT PRESENT |
1310 | XCONSUMERKEY NOT PRESENT |
1311 | SECURE CODE NOT PRESENT |
1320 | REQUEST_DATETIME_IS_MANDATORY |
1330 | CHANGE_CARD_STATUS_REQUEST_IS_NOT_ELGIBLE |
1343 | CARD_STATUS_LOCKED |
HTTP status code
HTTP Status Code | HTTP Status Description |
---|---|
200 | OK |
404 | Not Found |
500 | Internal Server Error |
400 | Bad Request |
Sample response
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}
Packet sample (Decrypted)
{
"urn": 70000000008,
"customerId": "62507sree4sd06",
"responseCode": "00",
"messageCode": 3011,
"clientTxnId": "ChangecardStatus000004",
"clientId": "1040",
"responseDateTime": "20220912173234",
"responseMessage": "SUCCESS",
"bankId": 6040,
"accosaRefNo": "28231"
}