Skip to main content

Get Transactions

This endpoint gets all transactions carried out by merchants

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

Method: POST

Request Parameters

TypeNameParameter RequiredDescription
stringstart_dateStart date of transactions range (if null, same day transactions would be fetched)
stringend_dateEnd date of the transaction range
stringchannel_codeRequiredClient application code
stringmerchant_idRequiredID of the merchant

Sample Request

{
"merchant_id": "YOUR MERCHANT ID",
"page_number": 1,
"page_size": 5,
"channel_code": "YOUR CHANNEL CODE",
"start_date": "28/09/2023",
"end_date": "29/09/2023"
}

Sample Response

{
"response_code": "00",
"response_message": "Successful Request",
"response_data": {
"transactions": [
{
"request_id": "VPAMT1818922561",
"customer_id": "08038087624",
"merchant_id": "MTN",
"virtual_account_no": "1433241033",
"virtual_account_name": "JON DOE",
"captured_datetime": "2021-11-23 18:55:34",
"completed_datetime": "2021-11-23 18:55:34",
"transaction_status": "COMPLETED",
"amount_paid": "2000",
"amount_moved_to_pool": "1996",
"notification_sent": "MessageSent"
},
{
"request_id": "VPAMT620320286",
"customer_id": "JONDOE",
"merchant_id": "MTN",
"virtual_account_no": "1433241095",
"virtual_account_name": "JON DOE",
"captured_datetime": "2021-11-23 18:55:10",
"completed_datetime": "2021-11-23 18:55:10",
"transaction_status": "COMPLETED",
"amount_paid": "5000",
"amount_moved_to_pool": "4990",
"notification_sent": "MessageSent",
"source_inst_code": "000014",
"session_id": "TST32643245345695221",
"transaction_type": "CREDIT"
}
]
}
}