Delete Beneficiary API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Delete Beneficiary API deletes an existing beneficiary for the customer in the prepaid system..

Environment

  
Sandboxhttps://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/beneficiary
ProductionContact 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:

ParameterTypeParameter RequirementDescription
messageCodeNumeric (4)MandatoryAPI response identifier.
clientTxnIdString (100)MandatoryValue echoed from the request.
responseDateTimeNumeric (14)MandatoryResponse date time in the format YYYYMMDDHHMMSS with time in 24-hour format.
urnNumeric (11)ConditionalA unique reference number for the card(urn)
clientIdString (10)MandatoryUnique ID for the client
bankIdString (10)MandatoryValue echoed from the request.
responseCodeString (4)MandatoryRepresents the status of the transaction.
responseMessageString (100)MandatoryResponse message based on the response code.
accosaTransactionIdNumeric (10)MandatoryUnique id for a particular transaction generated in Prepaid.
beneficiaryIdString (15)ConditionalA 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 CodeDescription
00SUCCESS
1001CARD NOT FOUND
1031INVALID BANK ID
1032INVALID_CLIENT_CHANNEL
1049INVALID SECURE CODE
1052SYSTEM_ERROR
1054DUPLICATE REQUEST
1055MALFORMED_REQUEST
1081OPERATION NOT ALLOWED
1083URN AND LAST 4 DIGITS MISMATCH
1084URN AND CUSTOMER ID MISMATCH
1085PRODUCT NOT ALLOWED
1085REQUESTOR UNAUTHORIZED FOR URN OR PRODUCT
1088INVALID REQUEST DATE FORMAT
1093INVALID CLIENT TXN ID
1116CARD AML PROFILE MISSING
1260BENEFICIARY ID NOT PRESENT IN THE REQUEST
1262CLIENT ID NOT PRESENT
1264BANK ID NOT PRESENT
1302INVALID CUSTOMER
1303CUSTOMER DETAILS NOT PRESENT
1304MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED
1310XCONSUMERKEY NOT PRESENT
1311SECURE CODE NOT PRESENT
1320REQUEST_DATETIME_IS_MANDATORY
5003CLIENT_NOT_CONFIGURED_UNDER_BANK_ID
9000NO BENEFICIARIES PRESENT
9001BENEFICIARY NOT PRESENT
10076THIS BENEFICIARY IS ALREADY DELETED
10080INVALID BENEFICIARY ID
30082BENEFICIARY ID NOT PRESENT

Request parameters

Body Params
string
required

This parameter must contain the token generated using the Encrypt API.

Headers
string
required

This parameter must contain the API key provided by Wibmo.

integer
required

This parameter must contain the Unique ID for the client shared by Wibmo.

integer
required

This parameter must contain the bank ID. Include 6060 for PayU.

integer
required

This parameter must contain the child corporate/branch entity ID under the client. This will be generated from the CMS. The default value is 100.

string
required

This parameter must contain the secure code that uniquely identifies the client on payload level for performing operations. Secure code will be shared by Wibmo separately.

string
required

This parameter must contain the unique consumer ID provided by the vendor for which bill is being paid or recharged.

Response
200
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!