Header Parameters

Name	Type	Description	Mandatory (M) , Optional (O)	Mandatory (M) , Optional (O)
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	String	Description
mobileNumber	String	Mobile Number of the Remitter
encryptedAadhaar	String	Aadhaar Number of Remitter in aes-256-cbc encryption
referenceKey	String	Reference key received in Remitter Profile Response

Sample Request

curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/remitterRegistration' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzxxxxxxxxxxxIEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cxxxxxxxxxxxxxf87f3000aa5b56fc926d1' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
    "mobileNumber":"9876543210",
    "encryptedAadhaar": "Nt8WtsZg84L+sakZg7Rstqpj5ucTephR3cM44TIM92o=",
    "referenceKey": "K6MsUIOCWyZeY+1Q3dWpgZV+04yJqRjYW/sWGR+i5uUoRSoszocxhWZA5awExQmY"
}'

POST /fi/remit/out/domestic/v2/remitterRegistration HTTP/1.1
Host: api.instantpay.in
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Client-Id: YWY3OTAzYzNlxxxxxxxxxxETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf6368xxxxxxxxxxxxxxx00aa5b56fc926d1
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 195

{
    "mobileNumber":"9876543210",
    "encryptedAadhaar": "Nt8WtsZg84L+sakZg7Rstqpj5ucTephR3cM44TIM92o=",
    "referenceKey": "K6MsUIOCWyZeY+1Q3dWpgZV+04yJqRjYW/sWGR+i5uUoRSoszocxhWZA5awExQmY"
}

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": {
        "validity": "2024-11-05 14:01:52",
        "referenceKey": "c2vt2c1C+65XaATXT1wifgyFeZuQEPpgGeMqTrmLwmy7RE4OryjqBYCkRsM767z4.v2.5538608139be2174-e6c6-49d2-a14e-aa2e9b360fba"
    },
    "timestamp": "2024-11-05 13:01:57",
    "ipay_uuid": "h0009d6a23bc-5de4-4f36-97a9-8dbcd499a752-CtQsi4PPIC3z",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}