The Create Beneficiary API is used for creation of beneficiary.
Environment: https://domain/api/onboarding/ v1/beneficiary/create
HTTP Method: POST
Request parameters
<WalletHeader />
Body
Parameter | Description | Example |
---|---|---|
Encrypted | ||
token |
| Pl8F5kDZcvADIiursiA |
Decrypted | ||
messageCode |
| 1080 |
clientTxnId |
| GOUd789hhhjfscs |
requestDateTime |
| |
customerId |
| 11001188721 |
urn |
| |
customerMobile |
| 919888888888 |
beneficiaryName |
| Ashish |
beneficiaryTypeCode |
| 1 |
bankName |
| HDFC Bank |
bankAccountNumber |
| 1234098753 |
ifscCode |
| HDFC00015 |
upiVpa |
| anything@payu |
beneficiaryMobileNumber |
| |
beneficiaryEmailId |
| |
nameMatchRatio |
| 98 |
maxTransactionAmountPerTxn |
| 500 |
maxTransactionAmountPerDay |
| 500 |
maxTransactionAmountPerMonth |
| 10000 |
maxCountTransactionPerDay |
| 10 |
maxCountTransactionPerMonth |
| 30 |
Sample request
Request packet (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}
Request packet (Decrypted)
{
"messageCode": "2010",
"clientTxnId": "207458URNACC37013134061",
"requestDateTime": "20161031214559",
"urn": 1435,
"beneficiaryName": "New Bene",
"beneficiaryTypeCode": "1",
"bankName": "AXIS",
"bankAccountNumber": "21486224170",
"ifscCode": "IDFB0010204",
"nameMatchRatio": 97
}
Response parameters
Parameter | Description | Example |
---|---|---|
Encrypted | ||
token | Token is the Encrypted body of the below request AES-192-CBC bits Encryption | Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV |
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 |
urn | A unique reference number for the card(urn) | 70000000008 |
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 |
accosaTransactionId | Unique id for a particular transaction generated in Prepaid | 3591893 |
beneficiaryId | A unique Beneficiary Id for the beneficiary. | 874743484374 |
accountNumber | Conditional with urn and customerId | 434532154 |
beneficiaryTypeCode | Can contain any of following values :
| 1 |
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 |
1084 | URN AND CUSTOMER ID MISMATCH |
303135 | CREATE BENIFICIARY FAILURE |
1281 | INVALID BANK NAME |
1288 | IFSC CODE IS INVALID |
Sample response
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}
Packet sample (Decrypted)
{
"urn": 0,
"customerId": "62508sachin2479",
"responseCode": "00",
"messageCode": 2011,
"clientTxnId": "207458URNACC3722134061",
"beneficiaryTypeCode": "1",
"clientId": "1",
"responseDateTime": "2023/10/10 12:54:39",
"bankId": 7020,
"beneficiaryId": 51465570
}