OTP Validation

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

NameTypeDescription
otpReferenceStringSame as received in
API response
otpstringReceived on Remitter Number

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/remit/out/domestic/otpVerification' \
--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 '{
    "otpReference": "6c454f306c786b44397254334c323138586c4576616f7647517766416c7274724f78545a632f4c326d3364537a744d4247786b4b4e644359614e6b5253534d337a78344e7a364870354d69664573352b42454e38517871364145355476767266364a2b33546168555343567975696e347a36766e33536b3876454f4d6a577831794741436b79776a63556a6d354969424b7752765979532b46592b78636c304359412f6345493142374c5759464c51454637565379565658386c4445787a7367686e72482b6d316d35313672386a6e71533354413936755067385558374b62556b4e46775a336256524f343d",
    "otp": "876341"
}'
POST /fi/remit/out/domestic/otpVerification HTTP/1.1
Host: api.instantpay.in
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

{
    "otpReference": "6c454f306c786b44397254334c323138586c4576616f7647517766416c7274724f78545a632f4c326d3364537a744d4247786b4b4e644359614e6b5253534d337a78344e7a364870354d69664573352b42454e38517871364145355476767266364a2b33546168555343567975696e347a36766e33536b3876454f4d6a577831794741436b79776a63556a6d354969424b7752765979532b46592b78636c304359412f6345493142374c5759464c51454637565379565658386c4445787a7367686e72482b6d316d35313672386a6e71533354413936755067385558374b62556b4e46775a336256524f343d",
    "otp": "876341"
}

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": "TXN",
    "actcode": null,
    "status": "Success",
    "data": {
        "mobile": "7428585742",
        "firstName": "Sample First Name",
        "lastName": "Sample Last Name",
        "address": "Samle Address",
        "city": "City Name",
        "state": "State Name",
        "pincode": "110044",
        "limitConsumed": "25000.00",
        "limitAvailable": "0.00",
        "limitIncreaseOffer": false,
        "beneficiaries": [
            {
                "id": "d580b9d86ec9f86cb26ce0cc4ed80726",
                "name": "Sample Full Name",
                "account": "7770007428585742",
                "ifsc": "YESB0CMSNOC",
                "bank": "Yes Bank"
            }
        ]
    },
    "timestamp": "2022-07-28 10:48:33",
    "ipay_uuid": "h00696e24438-a8bd-7e08dfddb672-fab3c8714750",
    "orderid": null,
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!