post https://api.instantpay.in/payments/payout/fetchBeneficiary
Fetching beneficiary details lets you review your existing list of recipients. Whether you're verifying their information or preparing for a transfer, this feature provides a quick way to access and manage your beneficiaries. Keeping an updated list helps ensure that your transfers are accurate and efficient.
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
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 beneficiaryType String Mandatory It will be OTHERS or AXIS
cURL HTTP
curl --location --globoff '{{host}}/payments/payout/fetchBeneficiary' \
--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": "4295906",
"accountNumber": "921020049249146"
},
"beneficiaryType":"OTHERS"
}'
POST /payments/payout/fetchBeneficiary 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: 141
{
"payer": {
"bankProfileId": "4295906",
"accountNumber": "921020049249146"
},
"beneficiaryType":"OTHERS"
}
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
