Unblock Card API

Unblock Card API is called by the client to Unblock the card in case of card is in the blocked state. Using this API, temporary and custom blocked cards can be unblocked, whereas permanent block cannot be unblocked.

Environment: https://domain/mob1/api/onboarding /v1/unblock

HTTP Method: PATCH

📘

Note:

The domain will be shared once this move to respective environment.

Request parameters

Body

Attribute

Description

Example

Encrypted

token
mandatory

String Token is the Encrypted body of the below request AES-192-CBC bits Encryption

 Pl8F5kDZcvADIiursiA
vvbHNuL9Wv5eaFdor
GVFU6FKfIEnV/YskkzJlA
ov2ZHJWnqGNLOXfBq4
SQqw8Ep4sK0gCAAkRX
ATCb1nSY6s=

Decrypted

messageCode
mandatory

Numeric Code to Identify load card request type.
Character Limit - 4

1080

clientTxnId
mandatory

String Unique ID generated by the client for each transaction.Character Limit - 14

GOUd789hhhjfscs

requestDateTime
mandatory

Numeric Local Date and time stamp when the transaction originated from the client in YYYYMMDDHHMMSS with time in 24 hr format.

20161031214559

customerId
mandatory

String Customer Id (entityCIF), which uniquely identifies the cardholder in the client system.. Conditional with mobile number and URN i.e either one of them should be present. Character Limit - 20

11001188721

last4Digits
mandatory

String Last 4 digits of the card number.
Character Limit - 4

7810

urn
mandatory

String A unique reference number for the generated card. Need to share this in request body of the APIs. Conditional with mobile number and Customer Id i.e either one of them should be present.
Character Limit - 11.

70000000008

reserved1
optional

String Audit details for block request (agentid).
Character Limit - 500.

Block

reserved2
optional

String Reason for card block.
Character Limit - 500

Investigating for fraud

Sample request

Packet sample (Encrypted)

{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
}

Packet sample (Decrypted)

{
"messageCode": "1072", "requestDateTime": "20161221210608", "clientTxnId": "ccccfccs",
"last4Digits": "0930",
"urn": 70000000008,
"customerId": "QW149",
"fromDate":"08/06/2015", "toDate": "30/06/2019", "pageNumber":"1", "count":"10", "fromRowId":"0"
}

Response parameters

Parameter

Description

Sample value

Encrypted

token

Token is the Encrypted body of the below request AES-192-CBC bits Encryption

 Pl8F5kDZcvADIiursiAvv
bHNuL9Wv5eaFdorGVFU6F
KfIEnV/YskkzJlAov2ZHJ
WnqGNLOXfBq4SQqw8Ep4
sK0gCAAkRXATCb1nSY6s=

Decrypted

messageCode

Code to Identify load response type.

1081

clientId

Value copied from the request

2000

clientTxnId

Value copied from the request

GOUd789hhhjfscs

bankId

Value copied from the request

7000

responseDateTime

Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format

20161031214559

urn

A unique reference number for the generated card by Prepaid system

70000000008

customerId

Customer Id(entityCIF), which uniquely identifies the cardholder in the client system.

Conditional with mobile number and Urn.

11001188721

accosaTransactionId

Unique ID for a particular transaction generated in Prepaid

3591893

responseCode

Contains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes

0

responseMessage

Response message based on response code will be sent

Success

description

Reserved field to send information to client

Success

accosaRefNo

Auto generated sequence number

123212

API error code

Error CodeDescription
00SUCCESS
1001CARD NOT FOUND
1009CARD CANCELLED CLOSED EXPIRED
1011CARD PERMANENT BLOCK
1012CARD PENDING CANCELLATION
1030INVALID MESSAGE
1034INVALID_MOBILE_NUMBER
1045UNABLE TO PROCESS REQUEST
1067CARD ALREADY UNBLOCKED
1231DATA_NOT_FOUND
1237DUPLICATE_PHONE_NUMBER_WITH_MULTIPLE_ACCOUNT
1356CARD_NOT_ACTIVE
1366PROGRAM IS INACTIVE

HTTP status code

HTTP Status CodeHTTP Status Description
200OK
404Not Found
500Internal Server Error
403Forbidden
400Bad Request
401Unauthorized
503Service 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": "IN00001201001865", "description": "UnBlocking", "responseCode": "00",
"messageCode": "1251",
"clientTxnId": "CUBL-456",
"clientId": "2000",
"responseDateTime": "20160715025837", "accosaTransactionId": 1024, "responseMessage": "Success", "accosaRefNo": "6007283",
"bankId": 7000
}