Beneficiary Registration

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	Requirement	Description
remitterMobile	String	Mandatory	Remitter Mobile Number
firstName	String	Mandatory	Full Name of Beneficiary
ifsc	String	Mandatory	Bank IFSC code of Beneficiary
accountNumber	String	Mandatory	Bank Account Number of Beneficiary

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/domestic/beneficiaryRegistration' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--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 'X-Ipay-Outlet-Id: {{outletId}}' \
--data-raw '{
    "remitterMobile":"7428585742",
    "firstName":"Sample First Name",
    "ifsc":"YESB0CMSNOC",
    "accountNumber":"7770007428585742"
}'

POST /fi/remit/out/domestic/beneficiaryRegistration HTTP/1.1
Host: api.instantpay.in
Accept: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
X-Ipay-Outlet-Id:{{outletId}}
Content-Type: application/json

{
    "remitterMobile":"7428585742",
    "firstName":"Sample First Name",
    "ifsc":"YESB0CMSNOC",
    "accountNumber":"7770007428585742"
}

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 sent to remitter mobile number XXXXXXX742",
    "data": {
        "otpReference": "706d73306a304232322b64795871366e4d6b465466596f6931594530463275346e6150644444666b764f5935744c707173517342654145787838746c72394a424b6b56695751764b4977755259325434497835377874576e30705637724a6d4b554a437345696d6575634b78645a71694a416d5a7732536a4b5849567976494479715547773d3d"
    },
    "timestamp": "2023-06-01 11:24:57",
    "ipay_uuid": "h005994de85a-03bd-461f-846c-6a64ff808e91",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}