Update Beneficiary API

The Update Beneficiary API updates 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 PATCH \
     --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": "8fxfVh1idLL19B4O5ZIYgw+4l/SAQ8pDK7yYz/3vEivzqv2VxD/Y7QFZJE+2wreYZpHxRF/qNnWizb2Ev62qv4ydSHBLok++hSp7crt3hXvO1K0TzYRxHrkYJaAquSrfOxFT0ktpN3bTd/9AfgaU2tdpUlp3MenjmIHUFdUb7jfSmHji+APVjrcDYWVCzbP6m7I5pikxE8cXMH+cOE0NAqUjokk3TFnXrBLc8E5enodVj31I7kaidXH9oClXNZq3l2CCiepp4eWekQrAEo1dpbsVR4dRZuVomNkKl4TPYu4="
}
'

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
newBeneficiaryType	String (15)	optional	Updated beneficiary type `SELF` / `OTHERS`
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)

{
    "responseCode": "00",
    "messageCode": 20001,
    "clientTxnId": "SeUNjc1705652745",
    "clientId": "2030",
    "responseDateTime": "20240119135546",
    "accosaTransactionId": 11375,
    "responseMessage": "SUCCESS",
    "bankId": 7030,
    "beneficiaryId": "37477009",
    "newBeneficiaryType": "SELF",
    "beneficiaryTypeCode": 1
}

Error codes

Error Code	Description
00	SUCCESS
1030	INVALID MESSAGE
1031	INVALID BANK ID
1032	INVALID_CLIENT_CHANNEL
1034	INVALID MOBILE NUMBER
1034	INVALID MOBILE NUMBER
1049	INVALID SECURE CODE
1052	SYSTEM_ERROR
1054	DUPLICATE REQUEST
1055	MALFORMED_REQUEST
1085	PRODUCT NOT ALLOWED
1093	INVALID CLIENT TXN ID
1262	CLIENT ID NOT PRESENT IN THE REQUEST
1264	BANK ID NOT PRESENT IN THE REQUEST
1276	INVALID BENEFICIAY MOBILE NUMBER
1279	BENEFICIARY IS BLOCKED
1311	SECURE CODE NOT PRESENT IN REQUEST
1320	REQUEST_DATETIME_IS_MANDATORY
7905	INVALID BENEFICIARY LIMIT
7920	BENEFICIARY MOBILE NUMBER CANNOT BE UPDATED AS BENEFICIARY MODE IS NOT 3
7921	BENEFICIARY ALREADY EXIST WITH THIS MOBILE NUMBER
7922	BENEFICIARY ALREADY EXIST WITH THIS NAME
7923	BENEFICIARY ALREADY EXIST WITH THIS EMAIL
7924	REQUEST AMOUNT PER TXN EXCEEDS GLOBAL LIMIT
7925	REQUEST 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
10043	Invalid Mobile Number Length
10048	INVALID EMAIL FORMAT
10080	INVALID BENEFICIARY ID
10081	INVALID BENEFICIARY TYPE
30082	BENEFICIARY ID NOT PRESENT

Request parameters