post https://api.instantpay.in/fi/remit/out/domestic/fundTransfer
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 | Description |
|---|---|---|
| remitterMobile | String | Mobile Number of Remitter |
| beneficiaryId | String | |
| transferMode | String | Modes can be IMPS,NEFT or RTGS |
| transferAmount | String | Amount to be transferred |
| latitude | String | Current location latitude |
| longitude | String | Current location longitude |
| externalRef | String | Unique Reference number |
Note:
Click here for guidelines for entering data in latitude/ longitude parameter.
Sample Request
curl --location --request POST 'https://api.instantpay.in/fi/remit/out/domestic/fundTransfer' \
--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",
"beneficiaryId":"9a1a15fd6aed4c3205e1a85",
"transferMode":"IMPS",
"transferAmount":2,
"latitude":"20.3254",
"longitude":"70.3214",
"externalRef":"abc1256"
}'
POST /fi/remit/out/domestic/fundTransfer 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",
"beneficiaryId":"9a1a15fd6aed4c3205e1a85",
"transferMode":"IMPS",
"transferAmount":2,
"latitude":"20.3254",
"longitude":"70.3214",
"externalRef":"abc1256"
}
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": "abc1256",
"poolReferenceId": "1220424130343AXKFAQ",
"txnValue": "2.00",
"txnReferenceId": "2243598352",
"pool": {
"account": "7428585742",
"openingBal": "22.72",
"mode": "DR",
"amount": "8.70",
"closingBal": "14.02"
},
"remitterMobile": "7428585742",
"beneficiaryAccount": "7770007428585742",
"beneficiaryIfsc": "YESB0CMSNOC"
},
"timestamp": "2022-07-25 16:38:56",
"ipay_uuid": "h0059be1de76-e3bd-4f83-a8bd-7e08dfddb672-iBDV4k0anFAu",
"orderid": "1220424130343AXKFAQ",
"environment": "LIVE",
}
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.