post https://api.instantpay.in/payments/payout/addBeneficiary
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.firstName | String | Mandatory | Beneficiary Name |
| payee.accountNumber | String | Mandatory | Account Number of End User |
| payee.ifsc | String | Mandatory | IFS Code |
| beneficiaryType | String | Mandatory | It will be OTHERS or AXIS |
| otpReference | String | Mandatory | otpReference |
| otp | String | Mandatory | otp |
Sample Request
curl --location --globoff '{{host}}/payments/payout/addBeneficiary' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: vOSSM+C/FQe8sBzp/QsqgqIlk1yoWakR3qtuhKafBMs=' \
--header 'X-Ipay-Client-Secret: 16eb5aaa6e16bd615dcdba445149961378c99a1de80c9e56cf601ba7c079e9cb' \
--header 'X-Ipay-Endpoint-Ip: 125.0.0.1' \
--header 'Content-Type: text/plain' \
--data '{
"payer": {
"bankProfileId": "4295906",
"accountNumber": "921020049249146"
},
"payee":{
"firstName":"aqqq",
"accountNumber":"123456987654",
"ifsc":"SBIN0000001"
},
"beneficiaryType":"OTHERS",
"otpReference":"",
"otp":""
}'
POST /payments/payout/addBeneficiary HTTP/1.1
Host: {{host}}
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: vOSSM+C/FQe8sBzp/QsqgqIlk1yoWakR3qtuhKafBMs=
X-Ipay-Client-Secret: 16eb5aaa6e16bd615dcdba445149961378c99a1de80c9e56cf601ba7c079e9cb
X-Ipay-Endpoint-Ip: 125.0.0.1
Content-Type: text/plain
Content-Length: 303
{
"payer": {
"bankProfileId": "4295906",
"accountNumber": "921020049249146"
},
"payee":{
"firstName":"aqqq",
"accountNumber":"123456987654",
"ifsc":"SBIN0000001"
},
"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 |
Note:
When received OTP for Adding Beneficiary call this API for OTP Verification