Fund Transfer

This API is used to initiate the transactions.

Request Parameters

ParametersRequirementDescription
remitterMobileMandatoryMobile Number of the Remitter
beneficiaryIdMandatoryBeneficiary Id
transferAmountMandatoryAmount to be Transferred
externalRefMandatoryUnique Transaction Id
remittanceReasonMandatoryReason of the Remittance
( You will get this from Static Data API )
otpReferenceMandatoryOtp Reference Id
otpMandatoryOTP Received on Remitter Mobile
latitudeMandatoryEnd User Location
longitudeMandatoryEnd User Location

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/nepal/fundTransfer' \
--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-Request-Hash: {{requestHash}}' \
--header 'X-Ipay-Request-Timestamp: {{timeStamp}}' \
--header 'X-Ipay-Hash-Check: OFF' \
--header 'User-Agent: InstantPayAPITest/1.0.0' \
--header 'X-Ipay-Outlet-Id: {{outletId}}'\
--header 'Content-Type: application/json' \
--data-raw '{
    "externalRef":"098765432112345678900987654",
    "remitterMobile":"7428585742",
    "beneficiaryId":"1023753",
    "transferAmount":"10",
    "remittanceReason":"Educational Expenses",
    "otpReference":"a228d687-ed51-44b0-af1b-7c5af6137453",
    "otp":"172065",
    "latitude":"10.0000",
    "longitude":"20.0000"
}'
curl --location --request POST 'https://api.instantpay.in/fi/remit/out/nepal/fundTransfer' \
--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-Request-Hash: {{requestHash}}' \
--header 'X-Ipay-Request-Timestamp: {{timeStamp}}' \
--header 'X-Ipay-Hash-Check: OFF' \
--header 'User-Agent: InstantPayAPITest/1.0.0' \
--header 'X-Ipay-Outlet-Id: {{outletId}}'\
--header 'Content-Type: application/json' \
--data-raw '{
    "externalRef":"098765432112345678900987654",
    "remitterMobile":"7428585742",
    "beneficiaryId":"1023753",
    "transferAmount":"10",
    "remittanceReason":"Educational Expenses",
    "otpReference":"a228d687-ed51-44b0-af1b-7c5af6137453",
    "otp":"172065",
    "latitude":"10.0000",
    "longitude":"20.0000"
}'

Response Parameter

Parameter NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus message
dataArrayResponse Data (If Present)
timestampStringResponse time (YYYY-MM-DD HH:MM:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
enviromentStringLive/Sandbox
internalCodeStringIt will be null

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "externalRef": "098765432112345678900987654",
        "poolReferenceId": "1221012123758FHVCB",
        "txnValue": "10.00",
        "txnReferenceId": "00",
        "pool": {
            "account": "7428585742",
            "openingBal": "385.18",
            "mode": "DR",
            "amount": "116.30",
            "closingBal": "268.88"
        },
        "remitterMobile": "7428585742",
        "beneficiaryAccount": "",
        "beneficiaryBankName": "",
        "beneficiaryBranchId": "",
        "beneficiaryName": "Beneficiary Name",
        "exchangeRate": "1.60",
        "payoutAmount": "16.00",
        "payoutCurrency": "NPR"
    },
    "timestamp": "2022-10-12 12:38:03",
    "ipay_uuid": "h005977b4e22-6e03-4473-95da-d2d0fe0c04be",
    "orderid": "1221012123758FHVCB",
    "environment": "LIVE",
    "internalCode": null
}

📘

Info :

For API Headers Click Here

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