Update Beneficiary API

The Update Beneficiary API is used to update the beneficiary details.

URL: https://domain/api/onboarding/ v1/beneficiary/update

HTTP Method: GET

Request parameters

Body

Parameter	Description	Example
Encrypted
token mandatory	`String` Token is the Encrypted body of the below request AES-192-CBC bits Encryption	Pl8F5kDZcvADIiursiA vvbHNuL9Wv5eaFdorGV FU6FKfIEnV/YskkzJlA ov2ZHJWnqGNLOXfBq4S Qqw8Ep4sK0gCAAkRXAT Cb1nSY6s=
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. `Character Limit - 4`
customerId conditional	`String` Customer Id (entityCIF), which uniquely identifies the cardholder in the client system. It is conditional with mobile number and URN, i.e., either one of them should be present. `Character Limit - 20`	11001188721
beneficiaryId mandatory	`String` A unique Beneficiary Id for the beneficiary. `Character Limit` - 15	874743484374
beneficiaryType mandatory	`String`The benefiary type which has to be updated. Character Limit` - 15	SELF
beneficiaryName mandatory	`String` A unique reference number for the card(urn)`Character Limit - 100`	Ashish
beneficiaryMobileNumber conditional	`Numeric`To be passed in case of Beneficiary type code is 3 `Character Limit - 20`
beneficiaryEmailId conditional	`String` Email Address of the account holder. `Character Limit - 100`	[email protected]
nameMatchRatio optional	`Numeric`This contains the name match ratio of the beneficiary name	98
maxTransactionAmountPerTxn optional	`Numeric`To capture max. allowed fund transfer per txn to that beneficiary. Cannot exceed global fund transfer limit set at program level. `Character Limit - 10`	500
maxTransactionAmountPerDay optional	`Numeric`To capture max. allowed fund transfer per day to that beneficiary. Cannot exceed global fund transfer limit set at program level. `Character Limit - 10`	500
maxTransactionAmountPerMonth optional	`Numeric`To capture max. allowed fund transfer per month to that beneficiary. Cannot exceed global fund transfer limit set at program level. `Character Limit - 10`	10000
maxCountTransactionPerDay optional	`Numeric`To capture max. allowed no of transactions per day to that beneficiary. Cannot exceed global limit set at program level. `Character Limit - 10`	10
maxCountTransactionPerMonth optional	`Numeric` To capture max. allowed no of transactions per month to that beneficiary. Cannot exceed global limit set at program level. `Character Limit - 10`	30

Sample request

Request packet (Encrypted)

{ 

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

Request packet (Decrypted)

{ 
    "messageCode": 20000, 
    "clientTxnId": "1667550287347ecec9a76-da07-45fe-8dd2-eac944e724999", 
    "requestDateTime": "20220615123144", 
    "beneficiaryId": 51465570, \
    "beneficiaryType": "SELF" 
}

Response parameters

Parameter	Description	Example
Encrypted
token	Token is the Encrypted body of the below request AES-192-CBC bits Encryption	Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/ \nYskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb \n1nSY6s=
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
clientId	Uniquely ID for the client .	9712938648
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
bankId	Bank ID is provided by platform to identify issuer/PPI of the program.	7020
customerId	Unique value passed in the request will be echoed else unique value generated by the platform if not passed in the request	89342546
accosaTransactionId	Unique id for a particular transaction generated in Prepaid	3591893
beneficiaryId	A unique Beneficiary Id for the beneficiary.	874743484374
newBeneficiaryType	Updated beneficiary type	SELF or OTHER
beneficiaryMobileNumber	Contains the mobile number in case of Beneficiary type code - 3
maxTransactionAmountPerTxn	Max. allowed fund transfer per txn to that beneficiary. Cannot exceed global fund transfer limit set at program level.	500
maxTransactionAmountPerDay	Max. allowed fund transfer per day to that beneficiary. Cannot exceed global fund transfer limit set at program level.	500
maxTransactionAmountPerMonth	Max. allowed fund transfer per month to that beneficiary. Cannot exceed global fund transfer limit set at program level.	10000
maxCountTransactionPerDay	Max. allowed no of transactions per day to that beneficiary. Cannot exceed global limit set at program level.	10
maxCountTransactionPerMonth	Max. allowed no of transactions per month to that beneficiary. Cannot exceed global limit set at program level.	30

API error codes

Error Code	Description
00	SUCCESS
1055	MALFORMED_REQUEST
1085	PRODUCT NOT ALLOWED
1052	SYSTEM_ERROR
1032	INVALID_CLIENT_CHANNEL
1081	OPERATION NOT ALLOWED
1080	IP_NOT_ALLOWED
1049	INVALID SECURE CODE
1051	CHECKSUM FAILURE
1093	INVALID CLIENT TXN ID
1320	REQUEST_DATETIME_IS_MANDATORY
1031	INVALID BANK ID
1264	BANK ID NOT PRESENT
1262	CLIENT ID NOT PRESENT
1310	XCONSUMERKEY NOT PRESENT
1030	INVALID MESSAGE
1311	SECURE CODE NOT PRESENT
10081	INVALID BENEFICIARY TYPE
30082	BENEFICIARY ID NOT PRESENT
10080	INVALID BENEFICIARY ID

Sample response

Packet sample (Encypted)

{ 

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

Packet sample (Decrypted)

{ 
    "responseCode": "00", 
    "messageCode": 20001, \
    "responseMessage": "SUCCESS", 
    "bankId": 7020, 
    "clientTxnId": "207458URNACC3722134061", 
    "responseDateTime": "2023/10/10 12:54:39", 
    "beneficiaryId": 51465570, 
    "newBeneficiaryType": "SELF" 
}