Transactions List

This method provides a list of transactions with the added pagination feature. The pagination feature allows clients to fetch transactions in smaller, manageable chunks, enhancing the efficiency and performance of the request-response cycle.

Request Params:

SI NO	Parameter	Length	Type	Mandatory	Remarks
1	from_date	13	String	Y	Starting date of the required list (DD-MMM-YYYY) Ex: 01-JUN-2020
2	to_date	13	String	Y	End date of the required list (DD-MMM-YYYY) Ex: 01-JUN-2020
3	page_no	1 or 2	Integer	Y	Requested page number
4	page_size	1 or 2	Integer	N	Number of transactions per page Should be 1000 or less
5	reference_no	20	Integer	N	The reference a number of the transaction to needs to be retreived

Response Params:

SI NO	Parameter	Remarks
1	page_no	Requested page number
2	page_size	Number of transactions per page
3	total	Total number of pages of the list
4	has_next	Indicates if there is more than one page
5	date	Date and time of the transaction
6	remitter_reference_no	Remitter Reference Number
7	bank_reference_no	Bank Reference Number
8	type	Transaction type ex. "AccountCredit"
9	sender_name	Sender Name
10	receiver_name	Beneficiary Name
11	account_no	Beneficiary's Account Number.
13	paid_date	Beneficiary Cash Collected/Account Deposited Date
14	status	Transaction status code and description
15	currency_code	Currency Code Passed By Remitter To Balad
16	amount	Amount Passed By Remitter To Balad

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": 20,
        "total": 3,
        "has_next": false,
        "items": [
            {
                "date": "DD-MMM-YYYY hh:mm AM/PM",
                "remitter_reference_no": "BALADLINK-XXXXXXXXXX",
                "bank_reference_no": "XXXXXXXXXX",
                "type": "AccountCredit",
                "sender_name": "XXXXX XXXXX XXXXX",
                "receiver_name": "XXXXX XXXXX XXXXX",
                "account_number": "XXXXXXXXXX",
                "paid_date": "DD-MMM-YYYY",
                "status": "Transferred",
                "status_details": {
                    "code": 1,
                    "description": "Transferred"
                },
                "amount": 1.00,
                "currency_code": "EGP",
                "failing_reason": null
            },
            {
                "date": "DD-MMM-YYYY hh:mm AM/PM",
                "remitter_reference_no": "BALADLINK-XXXXXXXXXX",
                "bank_reference_no": "XXXXXXXXXX",
                "type": "AccountCredit",
                "sender_name": "XXXXX XXXXX XXXXX",
                "receiver_name": "XXXXX XXXXX XXXXX",
                "account_number": "XXXXXXXXXX",
                "paid_date": "DD-MMM-YYYY",
                "status": "SettledOpenForReturn",
                "status_details": {
                    "code": 1,
                    "description": "Transferred"
                },
                "amount": 1.00,
                "currency_code": "EGP",
                "failing_reason": null
            },
            {
                "date": "DD-MMM-YYYY hh:mm AM/PM",
                "remitter_reference_no": "BALADLINK-XXXXXXXXXX",
                "bank_reference_no": "",
                "type": "Wallet",
                "sender_name": "XXXXX XXXXX XXXXX",
                "receiver_name": "XXXXX XXXXX XXXXX",
                "account_number": "XXXXXXXXXX",
                "paid_date": "DD-MMM-YYYY",
                "status": "Transferred",
                "status_details": {
                    "code": 1,
                    "description": "Transferred"
                },
                "amount": 1.00,
                "currency_code": "EGP",
                "failing_reason": null
            }
        ]
    },
    "errors": null
}

🟠400Invalid From and To Date

🟠400From Date is greater than To Date Copy

🟠400No Record Found

🟠400Date difference cannot be more than 15 days