Outlet Login Status

Merchant 2FA is required for a day for onboarded merchant in the entire AePS Journey. This API will help to identify whether the Merchant has done the 2FA or not.

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

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/aeps/outletLoginStatus' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAz***************t+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 679db35f9*************20c04454004d2d825' \
--header 'X-Ipay-Endpoint-Ip:' \
--header 'X-Ipay-Outlet-Id: 72762'
POST /fi/aeps/outletLoginStatus HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAz*********cETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f92*************28ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Outlet-Id: 72762

Response Parameters

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 )

Sample Response

    "statuscode": "TXN",
    "actcode": "LOGINREQUIRED",
    "status": "Transaction Successful",
    "data": null,
    "timestamp": "2023-07-31 10:46:24",
    "ipay_uuid": "h00699c68d9d-2342-43d8-8cd2-eeb8265f7663",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null


Note :

1- Before starting AePS transactions, make sure to register the outlet.

2- To register the outlet for 2FA the merchant must check the status through Outlet Login status API.

2- If actcode is LOGINREQUIRED then proceed with Outlet Login Call and registered the merchant before initiating AePS transactions.

3- If actcode is LOGGEDIN, the outlet has been successfully registered and can now initiate transactions

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