Create Beneficiary API

The Create Beneficiary API creates a beneficiary for the customer in the prepaid system..

Environment


Sandbox	https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/beneficiary
Production	Contact your WIBMO KAM or support.

Sample request

curl --request POST \
     --url https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/beneficiary \
     --header 'X-Consumer-Custom-ID: F42BC4E7B801C834B630DE498473533F' \
     --header 'bankId: 6060' \
     --header 'clientId: 1060' \
     --header 'content-type: application/json' \
     --header 'entityId: 100' \
     --header 'secureCode: pu8gSMLNE7pNv36IlUmstU' \
     --header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725' \
     --data '
{
  "token": "Mdu+z9xHTjUQ6XM3QYLcys+ZEFJl5mU/oSL5GSHcjaSPvdMtf/gX2svQlIFCgNsp0wBl3iTW1M0Qi+SOuy9iNYPLoDYzYkTByke1DSu6UxlW1Dy8sUelAXDaAuR8Tvrb55dqZKa4rVt80ZtIUJGOE//cjXS2Qm//J1rw00qKz781z4cayEWTQzfli1JVepOlqTb4xGADSmnqHtmdEPSNy5unc2WJrLM1rUsf3FGw5BEZcVbH/78LgfTfZenO8rO/JhWV2di8Nw8H/0xZDD0GpxqkZQ5fw08dgIIJnHp9Qy4U5p7CbiciBSdqyivuuXq2YvkbwoIOrLct9Q70wBEHZ4167S2I55brylfImBzntgBJqGSPrjHT3ERYUv9DSbnOCBTDZxzNB5cTOWTebZpL+AN+ifw5ENfaKipQ+Xl5HP8fkCPYzmaU6C3pW7b/tdGi/6MAn7GBNb5nAVbphsGLlw=="
}
'

Response parameters (Decrypted)

This API will provide a token in the response that must be decrypted using the Decrypt API. The decrypted response is similar to the following:

Parameter	Type	Parameter Requirement	Description
messageCode	Numeric (4)	Mandatory	API response identifier.
clientTxnId	String (100)	Mandatory	Value echoed from the request.
responseDateTime	Numeric (14)	Mandatory	Response date time in the format YYYYMMDDHHMMSS with time in 24-hour format.
urn	Numeric (11)	Conditional	A unique reference number for the card(urn)
clientId	String (10)	Mandatory	Unique ID for the client
bankId	String (10)	Mandatory	Value echoed from the request.
responseCode	String (4)	Mandatory	Represents the status of the transaction.
responseMessage	String (100)	Mandatory	Response message based on the response code.
accosaTransactionId	Numeric (10)	Mandatory	Unique id for a particular transaction generated in Prepaid.
beneficiaryId	String (15)	Conditional	A unique Beneficiary Id got generated for the beneficiary.
accountNumber	String (15)	Conditional	Conditional with urn and customerId
beneficiaryTypeCode	Numeric (2)	Mandatory	Value echoed from the request.
beneficiaryMobileNumber	Numeric (14)	Conditional	Value echoed from the request.
maxTransactionAmountPerTxn	Numeric (10)	Optional	Value echoed from the request.
maxTransactionAmountPerDay	Numeric (10)	Optional	Value echoed from the request.
maxTransactionAmountPerMonth	Numeric (10)	Optional	Value echoed from the request.
maxCountTransactionPerDay	Numeric (10)	Optional	Value echoed from the request.
maxCountTransactionPerMonth	Numeric (10)	Optional	Value echoed from the request.

Sample response (Decrypted)

{
    "urn": 70000001234,
    "customerId": "000000000036",
    "responseCode": "00",
    "messageCode": 2011,
    "clientTxnId": "Bmpm6T1705651403",
    "clientId": "2030",
    "responseDateTime": "20220619143723",
    "accosaTransactionId": 11370,
    "responseMessage": "SUCCESS",
    "bankId": 7030,
    "beneficiaryId": 37477009,
    "beneficiaryTypeCode": 1
}

Error codes

Error Code	Description
00	SUCCESS
1009	CARD CANCELLED CLOSED EXPIRED
1010	CARD TEMPORARY BLOCKED
1011	CARD PERMANENT BLOCKED
1012	CARD PENDING CANCELLATION
1030	INVALID MESSAGE
1031	INVALID BANK ID
1032	INVALID_CLIENT_CHANNEL
1034	INVALID MOBILE NUMBER
1049	INVALID SECURE CODE
1051	CHECKSUM FAILURE
1052	SYSTEM_ERROR
1054	DUPLICATE REQUEST
1055	MALFORMED_REQUEST
1080	IP_NOT_ALLOWED
1081	OPERATION NOT ALLOWED
1084	URN AND CUSTOMER ID MISMATCH
1085	PRODUCT NOT ALLOWED
1091	INVALID CARDPROFILE ID
1093	INVALID CLIENT TXN ID
1261	BENEFICIARY NAME NOT PRESENT IN THE REQUEST
1262	CLIENT ID NOT PRESENT
1263	CUSTOMER ID NOT PRESENT IN THE REQUEST
1264	BANK ID NOT PRESENT
1267	MORE THAN ONE PAYMENT TYPE PRESENT IN THE REQUEST
1271	BENEFICIARY WITH SAME PAYMENT(ACCOUNT/MOBILE/UPI) DETAILS EXISTS
1272	BENEFICARY ID/ACCOUNT ALREADY EXISTS
1274	INVALID UPI VPA ID
1275	INVALID CUSTOMER ID
1276	INVALID BENEFICIAY MOBILE NUMBER
1277	CUSTOMER IS BLOCKED
1280	INVALID BENEFICIARY NAME
1281	INVALID BANK NAME
1288	IFSC CODE IS INVALID
1303	CUSTOMER DETAILS NOT PRESENT
1310	XCONSUMERKEY NOT PRESENT
1311	SECURE CODE NOT PRESENT
1320	REQUEST_DATETIME_IS_MANDATORY
1343	CARD STATUS LOCKED
7607	WEEKLY BENEFICIARY LIMIT REACHED, NO MORE BENEFICIARIES CAN BE CREATED
7608	MONTHLY BENEFICIARY LIMIT REACHED, NO MORE BENEFICIARIES CAN BE CREATED
7609	YEARLY BENEFICIARY LIMIT REACHED, NO MORE BENEFICIARIES CAN BE CREATED
7902	BENEFICIARY TXN LIMITS VALUES SHOULD BE EITHER POSITIVE OR ZERO
7903	PAYMENT DETAILS SHOULD BE PROVIDED ACCORDING TO BENEFICIARY TYPE CODE
7906	DAILY BENEFICIARY LIMIT REACHED, NO MORE BENEFICIARIES CAN BE CREATED
7924	REQUEST AMOUNT PER TXN EXCEEDS GLOBAL LIMIT
7925	REQEUST DAILY LIMIT EXCEEDS GLOBAL LIMIT
7926	REQUEST MONTHLY LIMIT EXCEEDS GLOBAL LIMIT
7927	REQUEST DAILY FREQUENCE EXCEEDS GLOBAL LIMIT
7928	REQUEST MONTHLY FREQUENCE EXCEEDS GLOBAL LIMIT
7929	DAILY LIMIT SHOULD BE WITHIN BENEFICIARY LEVEL LIMIT
10043	MOBILE NO INVALID LENGTH
10048	INVALID EMAIL FORMAT
10080	INVALID BENEFICIARY ID
27301	BENEFICIARY CREATION FAILED
303135	CREATE BENEFICIARY FAILURE

Request parameters