Account Transactions
This endpoint allows users retrieve customer's transaction details from their bank accounts. Transaction details include the bank name linked to the transaction, amount, location, transaction type (credit or debit), time, and date of occurrence.
NOTE
You have the option of using webhook as a type of response_mode. This will enable you get the transaction results through the url provided by you.
Request
{{baseUrl}}/api/v1/financial/account_transactions
Headers
Parameter | Type | Description |
---|---|---|
AppId | string | you would need to create an app to get your app ID |
Authorization | string | public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G |
Query Parameters
Parameter | Type | Description | |
---|---|---|---|
account_id * | string | account ID gotten from the widget | required |
last_transaction_id | string | the oldest transaction ID you want to start with | optional |
start_date | string | the start date of transaction you want to get | optional |
end_date | string | the end date of transaction you want to get | optional |
trans_type | string | either debit or credit | optional |
response_mode | string | Your preferred mode of results. It can either be paginated, not_paginated, or webhook. The default is paginated |
optional |
callback_url | string | callback url used as webhook | optional |
Response Sample
{
"entity": {
"transactions": [
{
"id": 1454,
"transaction_date": "2020-09-22",
"value_date": "2020-09-22",
"trans_type": "debit",
"bank_name": "Guaranty Trust Bank",
"amount": "200.00",
"available_balance": "0",
"reference": "0",
"narration": "Airtime Purchase USSD-101CT0000000002019935870-2349057014101"
},
{
"id": 1455,
"transaction_date": "2020-09-21",
"value_date": "2020-09-21",
"trans_type": "debit",
"bank_name": "Guaranty Trust Bank",
"amount": "300.00",
"available_balance": "0",
"reference": "0",
"narration": "Airtime Purchase USSD-101CT0000000002019365730-2349057014101"
},
{
"id": 1456,
"transaction_date": "2020-09-21",
"value_date": "2020-09-21",
"trans_type": "debit",
"bank_name": "Guaranty Trust Bank",
"amount": "200.00",
"available_balance": "0",
"reference": "0",
"narration": "Airtime Purchase USSD-101CT0000000002019343280-2349057014101"
},
.........
],
"total": 115,
"previous_page": "",
"next_page": 2,
"total_pages": 2,
"current_page": 1
}
}
curl -L -X GET '{{baseUrl}}/api/v1/financial/account_transactions ' \
-H 'Authorization: SECRET_KEY' \
-H 'AppId: APP_ID'
Updated 10 months ago