Headers 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

Parameters	Type	Description
mobileNumber	String	Remitter Mobile Number
encryptedAadhaar	String	Aadhaar number in aes-256-cbc encryption
referenceKey	String	referenceKey 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: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
    "mobileNumber":"9876543210",
    "encryptedAadhaar": "Nt8WtsZg84L+sakZg7Rstqpj5ucTephR3cM44TIM92o=",
    "referenceKey": "gtW8UnSNXvID3SdbWkWTQ6WnTfUMUMKYIhZkX/ACqBAyaAa3a8sU6/AFas0PFwH/"
}'

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: {{clientID}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 195

{
    "mobileNumber":"9876543210",
    "encryptedAadhaar": "Nt8WtsZg84L+sakZg7Rstqpj5ucTephR3cM44TIM92o=",
    "referenceKey": "gtW8UnSNXvID3SdbWkWTQ6WnTfUMUMKYIhZkX/ACqBAyaAa3a8sU6/AFas0PFwH/"
}

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 XXXXXXX234",
    "data": {
        "otpReference": "5a446e70514f41575a74654a6e49474d634f7057702b747a686c65562f637a54765872666b487437757071306a34364542774161394d306d71444e494365356c54456d4178716247736361435a412b3965774c524f444643615a453250676b4767765241324e634637306f71694a6c326878374835766d6d4538394d2b71303741574c46752b4e7758775631676a6d2b675669336267586e624546776479734c70783377474f31734171673d"
    },
    "timestamp": "2024-05-31 11:05:03",
    "ipay_uuid": "h0009c2c2266-9e58-461d-bb88-25a36363d0f3-s27798VjPK8V",
    "orderid": null,
    "environment": "LIVE"
}