Reset PIN API

The Reset PIN API is called by the client if a cardholder forgot his existing PIN and wants to reset the PIN. Before resetting the PIN, client needs to validate the card details.

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

HTTP Method: POST

Request parameters

Header

ParameterDescriptionExample
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 Prepaid2000
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., 100100
secureCode
mandatory
String Uniquely identifies the client on payload level for performing operations.AfYtlO5kqdySIjXyNmGg3F

Body

📘

Note:

Encryption or decryption methodology is AES-192-CBC bits encryption.

ParameterDescriptionExample

Encrypted

token
mandatory
String Token is the Encrypted body of the below request AES-192-CBC bits EncryptionPl8F5kDZcvADIiursiA
vvbHNuL9Wv5eaFdorGV
FU6FKfIEnV/YskkzJlA
ov2ZHJWnqGNLOXfBq4S
Qqw8Ep4sK0gCAAkRXAT
Cb1nSY6s=

Decrypted

messageCode
mandatory
Numeric Code to Identify load card request type. Character Limit - 41080
clientTxnId
mandatory
String Unique ID generated by the client for each transaction. Character Limit - 14GOUd789hhhjfscs
requestDateTime
mandatory
NumericLocal Date and time stamp when the transaction originated from the client in YYYYMMDDHHMMSS with time in 24 hr format
Character Limit - 13
20161031214559
last4Digits
mandatory
NumericThis parameter must contain the last 4 digit of card number. This parameter is conditional, so required with urn.
Character Limit - 4
4664
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
newPIN
mandatory
Numeric New cardholder PIN
Character Limit - 6
123456

Sample request

Packet sample (Encrypted)

{

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

Packet sample (Decrypted)

{
  "messageCode": "1120",
  "requestDateTime": "20160715025837",
  "clientTxnId": "201507271458370149gM90jY0",
  "newPIN": "121200",
  "urn": 70000000008,
  "last4Digits": "1745",
  "customerId": "IN00001201001868"
}

Response parameters

ParameterDescriptionExample

Encrypted

tokenToken is the Encrypted body of the below request AES-192-CBC bits EncryptionPl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb1nSY6s=

Decrypted</h3>

messageCodeCode to Identity create card response type1011
clientIdUnique ID for client2000
clientTxnIdValue copied from the request20150701235959xhstiesqfds
bankIdValue copied from the request7000
responseDateTimeResponse date time in the format YYYYMMDDHHMMSS with time in 24 hr format20161031214559
urnA unique reference number for the generated card/wallet by Prepaid system70000000008
customerIdCustomer Id (entityCIF), which uniquely identifies the
cardholder in the client system.
IN2016201611
accosaTransactionIdUnique id for a particular transaction generated in Prepaid3591893
responseCodeContains the status of the transaction. 201 indicates CREATED. Please refer Appendix for other response codes201
responseMessageResponse message based on response code will be sentCard creation successful
descriptionReserved field to send information to clientCard Creation response
accosaRefNoAuto generated sequence number.4565166

API error codes

Error CodeDescription
0SUCCESS
1034INVALID_MOBILE_NUMBER
1088INVALID_DATE_FORMAT
1090CARD_PROFILEID_MANDATORY
1091INVALID_CARDPROFILE_ID
1092INVALID_EMAIL_ADDRESS
1231DATA_NOT_FOUND
1237DUPLICATE_MOBILE_NUMBER_WITH_MULTIPLE_ACCOUNT
1306PROFILE_NOTFOUND
1309CARDPROFILE_MISTMATCH

HTTP status code

HTTP Status CodeHTTP Status Description
200OK
400Bad Request
401Unauthorized
500Internal Server Error
403Forbidden
404Not Found
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": "IN00001201001868",
  "description": "Reset Pin",
  "responseCode": "00",
  "messageCode": "1121",
  "clientTxnId": "201507271458370149gM90jY0",
  "clientId": "2000",
  "responseDateTime": "20160715025837",
  "accosaTransactionId": 1031,
  "responseMessage": "Success",
  "accosaRefNo": "6007283",
  "bankId": 7000
}