Get Merchant Transactions

This endpoint gets all credits to virtual accounts created under merchant for the date range supplied.

URL: https://developer-sandbox.accessbankplc.com/virtualpayapi/GetMerchantTransactions

Method: POST

Request Parameters

Type	Name	Parameter Required	Description
string	start_date		Start date of transactions range (if null, same day transactions would be fetched)
string	end_date		End date of the transaction range
string	channel_code	Required	Client application code
string	merchant_id	Required	ID of the merchant
int	page_number	Required	The page number of results to retrieve
int	page_size		The number of results per page

Sample Request

{ 
    "merchant_id": "YOUR MERCHANT ID", 
    "channel_code": "YOUR CHANNEL CODE", 
    "start_date": "23/11/2021", 
    "end_date": "23/11/2021" 
} 

Sample Response

{
    "response_code": "00",
    "response_message": "Successful Request",
    "response_data": {
        "transactions": [
            {
                "request_id": "VPAY099MJNL221659YWC",
                "customer_id": "jondoe@GMAIL.COM",
                "merchant_id": " YOUR MERCHANT ID ",
                "virtual_account_no": "1509600498",
                "virtual_account_name": "JON DOE",
                "captured_datetime": "2023-09-28 17:00:01",
                "completed_datetime": "2023-09-28 17:00:01",
                "transaction_status": "COMPLETED",
                "amount_paid": "100",
                "amount_moved_to_pool": "95",
                "source_account_name": "YAYA TEST TAOFEEQ",
                "source_account": "0039881692",
                "source_bank": "Access Bank",
                "narration": "For enjoyment",
                "customer_print_count": 0,
                "merchant_print_count": 0,
                "terminal_id": null,
                "merchant_name": "ESCROW TECHNOLOGIES",
                "callback_notification": "N",
                "callback_notification_message": null
            },
            {
                "request_id": "VPAY099MJNL221655OPO",
                "customer_id": "FADEGBI@GMAIL.COM",
                "merchant_id": " YOUR MERCHANT ID ",
                "virtual_account_no": "1509600498",
                "virtual_account_name": "JON DOE",
                "captured_datetime": "2023-09-28 16:59:11",
                "completed_datetime": "2023-09-28 16:59:11",
                "transaction_status": "COMPLETED",
                "amount_paid": "300",
                "amount_moved_to_pool": "295",
                "source_account_name": "JON DOE",
                "source_account": "1484224616",
                "source_bank": "Access Bank",
                "narration": "Testing",
                "customer_print_count": 0,
                "merchant_print_count": 0,
                "terminal_id": null,
                "merchant_name": "ESCROW TECHNOLOGIES",
                "callback_notification": "N",
                "callback_notification_message": null
            }
        ]
    }
}