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
remitterMobileNumber	String	M	Remitter Mobile Number
otp	String	M	OTP received on Remitter Mobile
beneficiaryId	String	M	Beneficiary ID received on Beneficiary registration response
referenceKey	String	M	referenceKey received on Beneficiary registration response

Sample Request

curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/beneficiaryRegistrationVerify' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNxxxxxxxx9Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cfxxxxxxxxxxxxxx7f3000aa5b56fc926d1' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '
{
    "remitterMobileNumber": "9876543210",
    "otp" : 232890,
    "beneficiaryId": "bc607ec901164b636d747cda039e99cf",
    "referenceKey": "AjBeNd0Dleda8VxJKIjgxLo18UXKgtPGENSCK0NQSMQxi04EpN039xzfW6i9jArq"
}'

POST /fi/remit/out/domestic/v2/beneficiaryRegistrationVerify HTTP/1.1
Host: api.instantpay.in
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Client-Id: YWY3OTAzYzNlMxxxxxxxxxxxt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf636816xxxxxxxxxxxxxxxx000aa5b56fc926d1
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 210


{
    "remitterMobileNumber": "9876543210",
    "otp" : 232890,
    "beneficiaryId": "bc607ec901164b636d747cda039e99cf",
    "referenceKey": "AjBeNd0Dleda8VxJKIjgxLo18UXKgtPGENSCK0NQSMQxi04EpN039xzfW6i9jArq"
}

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": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "beneficiaryId": "bc607ec901164b636d747cda039e99cf"
    },
    "timestamp": "2024-11-05 13:07:08",
    "ipay_uuid": "h0009d6a2598-6e37-4f84-95fc-0000c7f120cd-BIKdcqZh4HMM",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}