Generate Transaction OTP

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
remitterMobileNumberStringMRemitter Mobile Number
amountStringMAmount to be Transferred
referenceKeyStringMReference Key received in Remitter Profile response

Sample Request

curl --location 'https://api.instantpay.in/fi/remit/out/domestic/v2/generateTransactionOtp' \
--header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlxxxxxxxxxxxxxcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 82e4755d7c1cf63xxxxxxxxxxxxxxxxxxxx7f3000aa5b56fc926d1' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Outlet-Id: 72762' \
--header 'Content-Type: application/json' \
--data '{
    "remitterMobileNumber": "9876543210",
    "amount": "10.00",
    "referenceKey": "eQJgp/xnEmxgcECVKTeqBveQqekPO9zDdnsHJGldvztYBQEByrUoAdYpbm5hDD5X"
}'
POST /fi/remit/out/domestic/v2/generateTransactionOtp HTTP/1.1
Host: api.instantpay.in
X-Ipay-Endpoint-Ip: 14.142.186.142
X-Ipay-Client-Id: YWY3OTAzYzNlxxxxxxxxxxxxxxEcETrD5Yx+Q=
X-Ipay-Client-Secret: 82e4755d7c1cf6368xxxxxxxxxxxxxxxxxxxxf87f3000aa5b56fc926d1
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id: 72762
Content-Type: application/json
Content-Length: 155

{
    "remitterMobileNumber": "9876543210",
    "amount": "10.00",
    "referenceKey": "eQJgp/xnEmxgcECVKTeqBveQqekPO9zDdnsHJGldvztYBQEByrUoAdYpbm5hDD5X"
}

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive

Sample Response

{
    "statuscode": "OTP",
    "actcode": null,
    "status": "OTP Successfully sent",
    "data": {
        "validity": "2024-11-05 14:07:22",
        "referenceKey": "oyG2B/5LE7E+T918OByESTgxHJ78uTvv+hrzwRjAzs4C2C5MTFv5K2WUlnvePTz+.v2.3738a4095d25300b-213b-4e24-be9a-d58d64cc9e80",
        "isTxnBioAuthRequired": false
    },
    "timestamp": "2024-11-05 13:07:27",
    "ipay_uuid": "h0009d6a25b4-4b92-449b-908c-52a9967e9ea9-01rqAeeVGWcp",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!