The Delete Beneficiary API deletes 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 DELETE \
     --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": "DFZDLWv/QWp1ZXhVVnIBOuOA6OyjYnTThMSLbtWSIF7eXkmnmyn1G696Vs8r0TV6xuG0DlunZRB3HcwyoaHikwraToMuDOBfGUYibekqXb5INFaqYlvGmkwHhtz/zS7L1cxT1TQVikH5gFZAFcUJ4DRgWMXKKkl67NRoLwqxTBozCYnkHml+eSKSAgu02wH9Y0Pu56ZVCbfgdKI/i9JrOY2ZBkKpBknd9G5kZU3Ru0Kayhr+LmYqZXgrpfQjRy8wXnfGI1NBztfpZaEocMKmHMpLkimVfAPAzs5lsIiDxhs="
}
'

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.

Sample response (Decrypted)

{
    "customerId": "000000000036",
    "responseCode": "00",
    "messageCode": 2031,
    "clientTxnId": "Ypah111705653270",
    "clientId": "1060",
    "responseDateTime": "20240119140431",
    "accosaTransactionId": 11377,
    "responseMessage": "SUCCESS",
    "bankId": 7030,
    "beneficiaryId": 37477009
}

Error codes

Error Code	Description
00	SUCCESS
1001	CARD NOT FOUND
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
1083	URN AND LAST 4 DIGITS MISMATCH
1084	URN AND CUSTOMER ID MISMATCH
1085	PRODUCT NOT ALLOWED
1085	REQUESTOR UNAUTHORIZED FOR URN OR PRODUCT
1088	INVALID REQUEST DATE FORMAT
1093	INVALID CLIENT TXN ID
1116	CARD AML PROFILE MISSING
1260	BENEFICIARY ID NOT PRESENT IN THE REQUEST
1262	CLIENT ID NOT PRESENT
1264	BANK ID NOT PRESENT
1302	INVALID CUSTOMER
1303	CUSTOMER DETAILS NOT PRESENT
1304	MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED
1310	XCONSUMERKEY NOT PRESENT
1311	SECURE CODE NOT PRESENT
1320	REQUEST_DATETIME_IS_MANDATORY
5003	CLIENT_NOT_CONFIGURED_UNDER_BANK_ID
9000	NO BENEFICIARIES PRESENT
9001	BENEFICIARY NOT PRESENT
10076	THIS BENEFICIARY IS ALREADY DELETED
10080	INVALID BENEFICIARY ID
30082	BENEFICIARY ID NOT PRESENT

Request parameters