Transaction

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code - 1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Outlet-IdStringMerchant unique IDMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeMandatory (M) , Optional (O)Description
remitterMobileNumberStringMMobile Number of Remitter
accountNumberStringMAccount Number of the Beneficiary
ifscStringMModes can be IMPS,NEFT or RTGS
transferModeStringMModes can be IMPS or NEFT
transferAmountStringMAmount to be transferred
latitudeStringMCurrent location latitude
longitudeStringMCurrent location longitude
referenceKeyStringMReference Key received in Generate transaction OTP response
otpStringMOTP received on Mobile Number
externalRefStringMYour 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

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/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.

Language
Click Try It! to start a request and see the response here!