post https://api.instantpay.in/payments/payout/deleteBeneficiary
When a beneficiary is no longer needed, deleting them from your list helps keep your account organized. Removing outdated or inactive beneficiaries ensures your list remains relevant, reducing the chances of errors in future transactions. This function gives you full control over who you can transfer funds to.
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code is "1" (Fixed) | M | Y |
| X-Ipay-Client-Id | String | Unique Client ID | M | Y |
| X-Ipay-Client-Secret | String | Unique secret key | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Request Parameter
| Parameter Name | Type | Requirement | Description |
|---|---|---|---|
| payer | Array | Mandatory | Payer details |
| payer.bankProfileId | String | Mandatory | Unique Bank Profile Id |
| payer.accountNumber | String | Mandatory | Account number of the Connected Bank |
| payee | Array | Mandatory | Payee details |
| payee.beneficiaryId | String | Mandatory | Account Holder Name |
| payee.payeeListId | String | Mandatory | IFS Code |
| payee.accountNumber | String | Mandatory | Account Number of End User |
| beneficiaryType | String | Mandatory | beneficiary Type |
| otpReference | String | Mandatory | otpReference |
| otp | String | Mandatory | otp |
Sample Request
curl --location --globoff '{{host}}/payments/payout/deleteBeneficiary' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data '{
"payer": {
"bankProfileId": "19993295906",
"accountNumber": "923020006320724"
},
"payee": {
"beneficiaryId": "",
"payeeListId": 317512375,
"accountNumber": "0987654321"
},
"beneficiaryType": "OTHERS",
"otpReference": "",
"otp": ""
}'
POST /payments/payout/deleteBeneficiary HTTP/1.1
Host: {{host}}
-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
Content-Length: 315
{
"payer": {
"bankProfileId": "19993295906",
"accountNumber": "923020006320724"
},
"payee": {
"beneficiaryId": "",
"payeeListId": 317512375,
"accountNumber": "0987654321"
},
"beneficiaryType": "OTHERS",
"otpReference": "",
"otp": ""
}
Response Parameter
| Parameter Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status message |
| data | Array | Response Data (If Present) |
| timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live/Sandbox |
| internalCode | String | It will be null |
Note :
When received OTP for Deleting Beneficiary call this API for OTP Verification