Get Category

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 --request GET 'https://api.instantpay.in/marketplace/utilityPayments/category' \
--header 'Accept: 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 'Content-Type: application/json' \
--data-raw '
'
GET /marketplace/utilityPayments/category HTTP/1.1
Host: api.instantpay.in
Content-Type: application/json
Accept: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}

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": "Biller Category fetched successfully",
    "data": [
        {
            "categoryKey": "C00",
            "categoryName": "Mobile Prepaid"
        },
        {
            "categoryKey": "C01",
            "categoryName": "Mobile Postpaid"
        },
        {
            "categoryKey": "C02",
            "categoryName": "Landline"
        },
        {
            "categoryKey": "C03",
            "categoryName": "DTH"
        },
        {
            "categoryKey": "C06",
            "categoryName": "Cable TV"
        },
        {
            "categoryKey": "C04",
            "categoryName": "Electricity"
        },
        {
            "categoryKey": "C05",
            "categoryName": "Broadband"
        },
        {
            "categoryKey": "C05",
            "categoryName": "Broadband"
        },
        {
            "categoryKey": "C07",
            "categoryName": "Piped Gas"
        },
        {
            "categoryKey": "C07",
            "categoryName": "Piped Gas"
        },
        {
            "categoryKey": "C08",
            "categoryName": "Water"
        },
        {
            "categoryKey": "C09",
            "categoryName": "Education Fee"
        },
        {
            "categoryKey": "C10",
            "categoryName": "FASTag"
        },
        {
            "categoryKey": "C11",
            "categoryName": "Insurance"
        },
        {
            "categoryKey": "C11",
            "categoryName": "Insurance"
        },
        {
            "categoryKey": "C11",
            "categoryName": "Insurance"
        },
        {
            "categoryKey": "C13",
            "categoryName": "Loan EMI"
        },
        {
            "categoryKey": "C14",
            "categoryName": "Gas Cylinder"
        },
        {
            "categoryKey": "C19",
            "categoryName": "Municipal Taxes"
        },
        {
            "categoryKey": "C19",
            "categoryName": "Municipal Services"
        },
        {
            "categoryKey": "C15",
            "categoryName": "Credit Card"
        },
        {
            "categoryKey": "C18",
            "categoryName": "Subscription"
        },
        {
            "categoryKey": "C18",
            "categoryName": "Subscription"
        },
        {
            "categoryKey": "C22",
            "categoryName": "Clubs & Associations"
        },
        {
            "categoryKey": "C17",
            "categoryName": "Housing Society"
        },
        {
            "categoryKey": "C21",
            "categoryName": "Hospital & Pathology"
        },
        {
            "categoryKey": "C21",
            "categoryName": "Hospital & Pathology"
        },
        {
            "categoryKey": "C20",
            "categoryName": "Recurring Deposit"
        }
    ],
    "timestamp": "2022-09-14 11:44:09",
    "ipay_uuid": "h0059742e758-***************-199244986179",
    "orderid": null,
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!