Bill Payment List

This API endpoint returns a list of payments that have been completed.

Response Params

Parameter	Remarks
page_no	The current page number.
page_size	The number of items per page.
total	The total number of payments.
has_next	Indicates whether there are more pages available.
items	An array containing payment objects.
reference_no	The reference number of the payment.
service_category	The category of the service.
service_provider	The provider of the service.
service	The name of the service.
account_number	The account number involved in the payment.
created_at	The timestamp when the payment was created.
amount_egp	The amount of the payment in Egyptian pounds.
service_fees_egp	The fees associated with the service in Egyptian pounds.
total_amount_egp	The total amount of the payment in Egyptian pounds.
foreign_amount	The amount of the payment in foreign currency.
partner_foreign_fees	The fees applied by the partner in foreign currency.
total_foreign_amount	The total amount of the payment in foreign currency.
foreign_currency_code	The currency code of the foreign currency.
status	The status of the payment (code and description).
transaction_number	The transaction number associated with the payment.
transaction_date	The date of the transaction.
account_type	The type of the account involved in the payment.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "data": {
        "page_no": 1,
        "page_size": 10,
        "total": 2,
        "has_next": false,
        "items": [
            {
                "reference_no": "XXXXXXXXXXXX",
                "service_category": "Internet/ADSL",
                "service_provider": "We",
                "service": "Home Internet Bills",
                "account_number": "XXXXXXXXXXXX",
                "created_at": "XX-XXX-XXXX 00:00 AM",
                "amount_egp": XX,
                "service_fees_egp": XX,
                "total_amount_egp": XX,
                "foreign_amount": X.XX,
                "partner_foreign_fees": XX,
                "total_foreign_amount": XX.XX,
                "foreign_currency_code": "USD",
                "status": {
                    "code": 2,
                    "description": "Failed"
                },
                "transaction_number": "XXXXXXXXXXXX",
                "transaction_date": "XX-XXX-XXXX",
                "account_type": 2
            },
            {
                "reference_no": "XXXXXXXXXXXX",
                "service_category": "Internet/ADSL",
                "service_provider": "We",
                "service": "Home Internet Bills",
                "account_number": "XXXXXXXXXXXX",
                "created_at": "XX-XXX-XXXX 00:00 AM",
                "amount_egp": XX,
                "service_fees_egp": XX,
                "total_amount_egp": XXX,
                "foreign_amount": XXX,
                "partner_foreign_fees": XX,
                "total_foreign_amount": XXX.XX,
                "foreign_currency_code": "USD",
                "status": {
                    "code": 1,
                    "description": "Success"
                },
                "transaction_number": "XXXXXXXXXXXX",
                "transaction_date": "XX-XXX-XXXX",
                "account_type": 1
            },
            
        ]
    },
    "errors": null
}