Confirm Payment

Confirm Payment

This API endpoint is used to confirm a payment transaction. It requires the service ID and Balad's reference number.

Request Params

SI No	Parameter	Type	Mandatory	Remarks
1	service_id	String	Y	Unique service ID
2	balad_reference_number	String	Y	The reference number generated from the inquiry or fees endpoint depending on the service

Response Params

Parameter	Remarks
balad_reference_number	The reference number provided by Balad.
amount_egp	The amount of the transaction in Egyptian pounds.
account_number	The account number involved in the transaction.
display_message	A descriptive message about the transaction.
total_amount_egp	The total amount of the transaction in Egyptian pounds.
foreign_amount	The amount of the transaction in foreign currency.
total_foreign_amount	The total amount of the transaction in foreign currency.
foreign_currency_code	The currency code of the foreign currency used in the transaction.
transaction_number	The unique identifier of the transaction.
transaction_time	The timestamp of the transaction.
reference_number	The reference number of the transaction.
powered_by	The service provider powering the transaction.
fees_egp	The fees associated with the transaction in Egyptian pounds.

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": 55,
    "parameters":[
        {
            "key":"balad_reference_number",
            "value":"XXX"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "key": "balad_reference_number",
            "value": "XXX"
        },
        {
            "key": "amount_egp",
            "value": "XXX"
        },
        {
            "key": "account_number",
            "value": "XXXXXXXXXX"
        },
        {
            "key": "display_message",
            "value": "Home Internet 20GB"
        },
        {
            "key": "total_amount_egp",
            "value": "XXX"
        },
        {
            "key": "foreign_amount",
            "value": "XXX"
        },
        {
            "key": "total_foreign_amount",
            "value": "1XXX"
        },
        {
            "key": "foreign_currency_code",
            "value": "USD"
        },
        {
            "key": "transaction_number",
            "value": "XXXXXX"
        },
        {
            "key": "transaction_time",
            "value": "1-Dec-2023 12:30 PM"
        },
        {
            "key": "reference_number",
            "value": "XXXXXXX"
        },
        {
            "key": "powered_by",
            "value": "eKhales"
        },
        {
            "key": "fees_egp",
            "value": "XX"
        }
    ],
    "errors": null
}