Inquiry

This endpoint is used to initiate an inquiry for bill payments. It requires the service ID and input parameters retrieved from the service configuration endpoint.

Request Params

SI No	Parameter	Type	Mandatory	Remarks
1	service_id	String	Y	Unique identifier of the Service can be retreived from the Get Services endpoint
2	account_number	String	Y	The account number associated with the inquiry. e.g. mobile number
3	Amount	String	Y (if it is required for the service requested e.g Mobile recharge, Vodafone ADSL)	The amount to be charged/ paid

Response Params

Parameter	Remarks
account_number	The account number associated with the inquiry.
fees_egp	The fees associated with the inquiry (in EGP).
total_amount_egp	The total amount of the inquiry (in EGP).
amount_egp	The amount of the inquiry (in EGP).
balad_reference_number	The reference number generated for the inquiry.
foreign_amount	The amount of the inquiry (in foreign currency).
partner_foreign_fees	The fees applied in foreign currency.
total_foreign_amount	The total amount of the inquiry (in foreign currency).
foreign_currency_code	The currency code of the foreign currency.
display_message	A display message describing the inquiry.
is_fees_calculated	Indicates whether the fees are calculated.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Example

{
    "service_id": 1001,
    "parameters":[
        {
            "key":"account_number",
            "value":"02XXXXXXXXX"
        },
        {
            "key":"amount_egp",
            "value":"XXX"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Inquiry

application/json

Bodyapplication/json

Example

{
    "data": [
        [
            {
                "key": "balad_reference_number",
                "value": "XXXX"
            },
            {
                "key": "amount_egp",
                "value": "XXXX"
            },
            {
                "key": "account_number",
                "value": "XXXXXXXXXX"
            },
            {
                "key": "display_message",
                "value": "Home Internet 20GB"
            },
            {
                "key": "total_amount_egp",
                "value": "XX"
            },
            {
                "key": "foreign_amount",
                "value": "XX"
            },
            {
                "key": "total_foreign_amount",
                "value": "1"
            },
            {
                "key": "foreign_currency_code",
                "value": "USD"
            },
            {
                "key": "is_fees_calculated",
                "value": "false"
            },
            {
                "key": "fees_egp",
                "value": "XXX"
            }
        ]
    ],
    "errors": null
}

🟢200We Home Internet Bills

🟢200We Home Internet Top-Up

🟢200WE Mobile Bill

🟢200WE Mobile Recharge

🟢200Orange Home Internet Bills

🟢200Orange Mobile Bill

🟢200Orange Mobile Recharge

🟢200Vodafone Home Internet Bills

🟢200Vodafone Mobile Bill

🟢200Vodafone Mobile Recharge

🟢200Etisalat Home Internet Bills

🟢200Etisalat Mobile Bills

🟢200Etisalat Mobile Recharge

🟢200Petrotrade Gas Bills Payment

🟢200Nat Gas Bills Payment

🟢200Giza Water Bills Payment

🟢200Cairo Water Bills Payment

🟢200Alex Water Bills Payment

🟢200Menoufia Water Bills Payment

🟢200North Cairo Electricity Bills Payment

🟢200South Cairo Electricity Bills Payment

🟢200Go Bus Transportation