post https://api.instantpay.in/fi/remit/out/domestic/v2/transaction
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 | Mobile Number of Remitter |
accountNumber | String | M | Account Number of the Beneficiary |
ifsc | String | M | Modes can be IMPS,NEFT or RTGS |
transferMode | String | M | Modes can be IMPS or NEFT |
transferAmount | String | M | Amount to be transferred |
latitude | String | M | Current location latitude |
longitude | String | M | Current location longitude |
referenceKey | String | M | Reference Key received in Generate transaction OTP response |
otp | String | M | OTP received on Mobile Number |
externalRef | String | M | Your unique transaction Id |
Note:
Click here for guidelines for entering data in latitude/ longitude parameter.
Sample Request
curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/transaction' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2xxxxxxxxxxxxcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf636816xxxxxxxxxxxxxxxxxxx3000aa5b56fc926d1' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
"remitterMobileNumber":"9876543210",
"accountNumber":"325951041123",
"ifsc":"SBIN0000001",
"transferMode":"IMPS",
"transferAmount":"10.00",
"latitude":"28.5093",
"longitude":"77.2973",
"referenceKey": "oyG2B/5LE7E+T918OByESTgxHJ78uTvv+hrzwRjAzs4C2C5MTFv5K2WUlnvePTz+.v2.3738a4095d25300b-213b-4e24-be9a-d58d64cc9e80",
"otp":315662,
"externalRef":"1730801031"
}'
POST /fi/remit/out/domestic/v2/transaction HTTP/1.1
Host: api.instantpay.in
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Client-Id: YWY3OTAzYzNxxxxxxxxxxxxxxxEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cfxxxxxxxxxxxxxxxxxxxxxxxx3000aa5b56fc926d1
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 451
{
"remitterMobileNumber":"9876543210",
"accountNumber":"325951041123",
"ifsc":"SBIN0000001",
"transferMode":"IMPS",
"transferAmount":"10.00",
"latitude":"28.5093",
"longitude":"77.2973",
"referenceKey": "oyG2B/5LE7E+T918OByESTgxHJ78uTvv+hrzwRjAzs4C2C5MTFv5K2WUlnvePTz+.v2.3738a4095d25300b-213b-4e24-be9a-d58d64cc9e80",
"otp":315662,
"externalRef":"1730801076"
}
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 | 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 |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"externalRef": "1730792303",
"poolReferenceId": "1241105130825DLWAK",
"txnValue": "10.00",
"txnReferenceId": "431013704887",
"pool": {
"account": "9876543210",
"openingBal": "32.12",
"mode": "DR",
"amount": "15.95",
"closingBal": "16.17"
},
"remitterMobile": "9876543210",
"beneficiaryAccount": "325951041234",
"beneficiaryIfsc": "SBIN0000001",
"beneficiaryName": "Instantpay India Ltd"
},
"timestamp": "2024-11-05 13:08:28",
"ipay_uuid": "h0009d6a260b-44c0-4768-a7b2-0ffae7d2126c-5Ofm5Yev7azK",
"orderid": "1241105130825DLWAK",
"environment": "LIVE",
"internalCode": null
}
Important Information
Consider the Transaction as Pending when you get No Response or Timeout Response and then check the status of the transactions through Transaction Status API.