post https://api.instantpay.in/fi/remit/out/domestic/v2/beneficiaryRegistration
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 | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| beneficiaryMobileNumber | String | M | Beneficiary Mobile Number |
| remitterMobileNumber | String | M | Remitter Mobile Number |
| ifsc | String | M | Bank IFSC code of Beneficiary |
| accountNumber | String | M | Bank Account Number of Beneficiary |
| bankId | String | M | Bank ID |
| name | String | M | Full name of Beneficiary |
Sample Request
curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/beneficiaryRegistration' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzxxxxxxxxxxxxxcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf63681xxxxxxxxxxxxxxxxxxxxxxxxaa5b56fc926d1' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
"beneficiaryMobileNumber" : "8765432100",
"remitterMobileNumber":"9876543210",
"accountNumber":"32595104123",
"ifsc":"SBIN0000001",
"bankId": "109005",
"name": "Instantpay India Ltd"
}'
POST /fi/remit/out/domestic/v2/beneficiaryRegistration HTTP/1.1
Host: api.instantpay.in
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Client-Id: YWY3OTAzxxxxxxxxxxxx+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf636xxxxxxxxxxxxxxxxxxxxxf3000aa5b56fc926d1
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 197
{
"beneficiaryMobileNumber" : "8765432100",
"remitterMobileNumber":"9876543210",
"accountNumber":"32595104123",
"ifsc":"SBIN0000001",
"bankId": "109005",
"name": "Instantpay India Ltd"
}
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 13:21:43",
"referenceKey": "AjBeNd0Dleda8VxJKIjgxLo18UXKgtPGENSCK0NQSMQxi04EpN039xzfW6i9jArq"
},
"timestamp": "2024-11-05 13:06:43",
"ipay_uuid": "h0009d6a2571-6219-4e42-8650-c873188d38c4-io7qATebxFc0",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}
Important Point
When calling the Beneficiary Registration API, if the status code is OTP, you must validate the OTP using the Beneficiary Registration Verify endpoint. However, if the status code is TXN, no OTP validation is needed, as the beneficiary is registered automatically.
For the Transaction API (Fund Transfer), beneficiary registration is optional. You can perform a transfer to any beneficiary without registering them.