Header Parameters

Name	Type	Description	Mandatory (M) , Optional (O)	Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-Code	String	Auth Code - 1 (Fixed)	M	Y
X-Ipay-Client-Id	String	Unique Client ID	M	Y
X-Ipay-Client-Secret	String	Unique secret key	M	Y
X-Ipay-Outlet-Id	String	Merchant unique ID	M	Y
X-Ipay-Endpoint-Ip	String	End Customer IP Address	M	N

Sample Request

curl --location 'https://api.instantpay.in/fi/aeps/banks' \
--header 'Accept: application/json' \
--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}}'

GET /fi/aeps/banks HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: {{1}}
X-Ipay-Client-Id: {{clientID}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endpointIp}}
X-Ipay-Outlet-Id: {{outletId}}

Response Parameters

Name	Type	Description
statuscode	String	InstantPay Status Code
actcode	String	Action Code
status	String	Status Message
data	Array	Response Data (If Present)
timestamp	String	Current time (YYYY-MM-DD HH:II:SS)
ipay_uuid	String	Request reference number
orderid	String	Transaction Id ( If transaction otherwise it is null )
environment	String	Live

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Banks fetched successfully",
    "data": [
        {
            "bankId": 109005,
            "name": "STATE BANK OF INDIA",
            "iin": "607094",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "33",
            "aadhaarpayFailureRate": "45"
        },
        {
            "bankId": 74984,
            "name": "Punjab National Bank",
            "iin": "607027",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "16",
            "aadhaarpayFailureRate": "71"
        },
        {
            "bankId": 20500,
            "name": "INDIAN BANK",
            "iin": "607105",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "30",
            "aadhaarpayFailureRate": "67"
        },
        {
            "bankId": 134157,
            "name": "INDIA POST PAYMENTS BANK",
            "iin": "608314",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "45",
            "aadhaarpayFailureRate": "75"
        },
        {
            "bankId": 23061,
            "name": "INDIAN OVERSEAS BANK",
            "iin": "607126",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "26",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 91606,
            "name": "UNION BANK OF INDIA",
            "iin": "607161",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "32",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 47267,
            "name": "BANK OF INDIA",
            "iin": "508505",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "33",
            "aadhaarpayFailureRate": "50"
        },
        {
            "bankId": 39287,
            "name": "BANK OF BARODA",
            "iin": "606985",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "32",
            "aadhaarpayFailureRate": "78"
        },
        {
            "bankId": 53201,
            "name": "CANARA BANK",
            "iin": "607396",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "24",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134123,
            "name": "BANGIYA GRAMIN VIKASH BANK",
            "iin": "607063",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "11",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134125,
            "name": "BARODA UP BANK",
            "iin": "606993",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "39",
            "aadhaarpayFailureRate": "56"
        },
        {
            "bankId": 96035,
            "name": "UCO BANK",
            "iin": "607066",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "22",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 3487,
            "name": "CENTRAL BANK OF INDIA",
            "iin": "607264",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "41",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 1,
            "name": "AIRTEL PAYMENTS BANK",
            "iin": "990320",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "18",
            "aadhaarpayFailureRate": "50"
        },
        {
            "bankId": 64597,
            "name": "IndusInd Bank",
            "iin": "607189",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "16",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 30728,
            "name": "FINO PAYMENTS BANK",
            "iin": "608001",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "39",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134126,
            "name": "DAKSHIN BIHAR GRAMIN BANK",
            "iin": "607136",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "29",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134550,
            "name": "PRATHAMA UP GRAMIN BANK",
            "iin": "607135",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "11",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134120,
            "name": "BARODA RAJASTHAN KSHETRIYA GRAMIN BANK",
            "iin": "607280",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "0",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134138,
            "name": "SAPTAGIRI GRAMEENA BANK",
            "iin": "607053",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "44",
            "aadhaarpayFailureRate": "91"
        },
        {
            "bankId": 38669,
            "name": "ANDHRA PRAGATHI GRAMEENA BANK",
            "iin": "607121",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "11",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 106167,
            "name": "PUNJAB AND SIND BANK",
            "iin": "607087",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "26",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 27970,
            "name": "BANK OF MAHARASHTRA",
            "iin": "607387",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "25",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134135,
            "name": "TAMIL NADU GRAMA BANK",
            "iin": "607052",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "30",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 30301,
            "name": "ARYAVART BANK",
            "iin": "607024",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "25",
            "aadhaarpayFailureRate": "75"
        },
        {
            "bankId": 31197,
            "name": "Kotak Mahindra Bank",
            "iin": "990309",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "33",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 30273,
            "name": "ANDHRA PRADESH GRAMEENA VIKAS BANK",
            "iin": "607198",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "25",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 11263,
            "name": "HDFC Bank",
            "iin": "607152",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "27",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 62431,
            "name": "IDBI BANK",
            "iin": "607095",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "20",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134133,
            "name": "MADHYA PRADESH GRAMEEN BANK",
            "iin": "607022",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "25",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134142,
            "name": "TELANGANA GRAMEENA BANK",
            "iin": "607195",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "0",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134139,
            "name": "SARVA HARYANA GRAMIN BANK",
            "iin": "607139",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "14",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134137,
            "name": "PUNJAB GRAMIN BANK",
            "iin": "607138",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "0",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 74138,
            "name": "KARNATAKA GRAMIN BANK",
            "iin": "607400",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "20",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 15910,
            "name": "ICICI Bank",
            "iin": "508534",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "58",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 130878,
            "name": "Axis Bank",
            "iin": "607153",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "0",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 30520,
            "name": "CHHATTISGARH RAJYA GRAMIN BANK",
            "iin": "607214",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "38",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 31652,
            "name": "RAJASTHAN MARUDHARA GRAMIN BANK",
            "iin": "607509",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "33",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 33975,
            "name": "JHARKHAND RAJYA GRAMIN BANK",
            "iin": "607210",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "0",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134223,
            "name": "FINCARE SMALL FINANCE BANK",
            "iin": "817304",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "100",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 64460,
            "name": "IDFC FIRST Bank",
            "iin": "608117",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "50",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 31276,
            "name": "MADHYANCHAL GRAMIN BANK",
            "iin": "607232",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "50",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 69808,
            "name": "KARNATAKA VIKAS GRAMEENA BANK",
            "iin": "607122",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "0",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134143,
            "name": "TRIPURA GRAMIN BANK",
            "iin": "607065",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "0",
            "aadhaarpayFailureRate": "100"
        },
        {
            "bankId": 134657,
            "name": "THE SIVAGANGAI DISTRICT CENTRAL CO-OP BANK",
            "iin": "508649",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "100",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134538,
            "name": "THE YAVATMAL DISTRICT CENTRAL CO-OP BANK",
            "iin": "607602",
            "aepsEnabled": true,
            "aadhaarpayEnabled": false,
            "aepsFailureRate": "100",
            "aadhaarpayFailureRate": "0"
        },
        {
            "bankId": 134193,
            "name": "UTTAR PRADESH CO-OP BANK",
            "iin": "607523",
            "aepsEnabled": true,
            "aadhaarpayEnabled": true,
            "aepsFailureRate": "100",
            "aadhaarpayFailureRate": "0"
        }
    ],
    "timestamp": "2024-12-09 16:30:37",
    "ipay_uuid": "h0009daed3d3-37f1-4854-ab9a-9782e0d5b00a-Rg8XyNhCExF7",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}

200200

400400