Fetch Beneficiary API

The Fetch Beneficiary API is used to fetch an existing 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 GET \
     --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 'entityId: 100' \
     --header 'secureCode: pu8gSMLNE7pNv36IlUmstU' \
     --header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725'

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.
beneficiaryDataList	Object	Mandatory	Beneficiary details.

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
1030	INVALID MESSAGE
1031	INVALID BANK ID
1032	INVALID_CLIENT_CHANNEL
1049	INVALID SECURE CODE
1052	SYSTEM_ERROR
1054	DUPLICATE REQUEST
1055	MALFORMED_REQUEST
1081	OPERATION NOT ALLOWED
1085	PRODUCT NOT ALLOWED
1093	INVALID CLIENT TXN ID
1262	CLIENT ID NOT PRESENT IN THE REQUEST
1263	CUSTOMER ID NOT PRESENT IN THE REQUEST
1264	BANK ID NOT PRESENT IN THE REQUEST
1310	XCONSUMERKEY NOT PRESENT IN REQUEST
1311	SECURE CODE NOT PRESENT IN REQUEST
1320	REQUEST_DATETIME_IS_MANDATORY
9000	NO BENEFICIARIES PRESENT
9006	TRANSFER TYPE IS INVALID
10074	ACTIVATION STATUS NOT PRESENT IN THE REQUEST
10075	INVALID ACTIVATION STATUS
10079	TRANSFER TYPE NOT PRESENT IN THE REQUEST
77101	Invalid data type for field Message Code
85114	Invalid data type for field Urn

Request parameters