post https://api.instantpay.in/fi/remit/out/domestic/v2/beneficiaryDelete
Header Parameters
| Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
|---|---|---|---|---|
| X-Ipay-Auth-Code | String | Auth Code - 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-Outlet-Id | String | Merchant unique ID | M | Y |
| X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Request Parameters
| Name | Type | Description |
|---|---|---|
| remitterMobileNumber | String | Remitter Mobile Number |
| beneficiaryId | String | Beneficiary ID |
Sample Request
curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/beneficiaryDelete' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: YWY3OTAzYxxxxxxxxxxxxxxxxxt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf636816xxxxxxxxxxxxxxxxxxxxxx3000aa5b56fc926d1' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
"remitterMobileNumber": "9876543210",
"beneficiaryId": "bc607ec901164b636d747cda039e99cf"
}'
POST /fi/remit/out/domestic/v2/beneficiaryDelete HTTP/1.1
Host: api.instantpay.in
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Client-Id: YWY3OTAzYzNxxxxxxxxxxxxxt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf636816axxxxxxxxxxxxxxxxxx00aa5b56fc926d1
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 101
{
"remitterMobileNumber": "9876543210",
"beneficiaryId": "bc607ec901164b636d747cda039e99cf"
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status Code |
| actcode | String | Action Code |
| status | String | Status Message |
| data | Array | Response Data (If Present) |
| timestamp | String | Current 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 |
Sample Response
{
"statuscode": "OTP",
"actcode": null,
"status": "OTP Successfully sent",
"data": {
"beneficiaryId": "bc607ec901164b636d747cda039e99cf",
"validity": "2024-11-05 15:24:50",
"referenceKey": "IDwRJSrFsTtuvlqxKVO85GsBBiPD/kyqvi71VEZxPKmFVBwbxX7XkH33DwJW1rqv"
},
"timestamp": "2024-11-05 15:09:50",
"ipay_uuid": "h0009d6a5179-133f-45a1-b29d-0435cfba2839-iqsBiKQIDQ7p",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}
Important Point
When calling the Beneficiary Deletion API, if the status code is OTP, you must validate the OTP using the Beneficiary Deletion Verify endpoint. However, if the status code is TXN, no OTP validation is needed, as the beneficiary is deleted automatically.