Transactions
List transactions
List Transactions
The List Transactions API lets you retrieve all your payout transactions directly without needing to check the dashboard. Simply use the following GET endpoint:
{{baseurl}}/transactions
Remember: To ensure security, your secret key is required as an authorization header.
The parameters for this request query include:
Field | Data Type | Description |
---|---|---|
list | number >=1 | This specifies the maximum number of transactions you want to retrieve in a single API call. It must be a number greater than or equal to 1. |
page | number >=1 | This allows you to navigate through your transaction history in pages. It must be a number greater than or equal to 1. |
search | String | This allows you to search for specific transactions within your history. |
type | Object: Enum CREDIT DEBIT | This is a filter for the type of transactions you want to retrieve. It can be set to either “CREDIT” to get only credit transactions or “DEBIT” to get only debit transactions. |
A successful response will look like this:
{
"success": true,
"statusCode": 200,
"message": "Fetched transactions list",
"data": {
"transactions": [
{
"id": "29ccbb6f-6204-49a8-a33f-ccac5bb94f6c",
"amount": 10,
"status": "PENDING",
"fee": 0,
"description": "Deposit",
"type": "CREDIT",
"channel": null,
"method": null,
"currency": "NGN",
"createdAt": "2024-04-28T03:03:35.346Z",
"updatedAt": "2024-04-28T03:03:35.346Z",
"businessId": "",
"reference": "",
"depositId": "",
"spendingId": null,
"refundId": null,
"topupId": null,
"tuitionId": null,
"walletId": "",
"cardId": null,
"swapId": null,
"balance": null,
"refund": null,
"topup": null,
"spending": null,
"deposit": {
"id": "",
"currency": "NGN",
"amount": 10,
"fee": 0,
"amountSent": 10,
"status": "PENDING",
"depositType": "BANK_TRANSFER",
"createdAt": "2024-04-28T03:03:35.346Z",
"updatedAt": "2024-04-28T03:03:35.346Z",
"provider": null,
"providerId": ""
},
"billPayment": null,
"swap": null
},
{
"id": "405ceef4-fb6a-44eb-8d01-694af447b86a",
"amount": 1000,
"status": "PENDING",
"fee": 0,
"description": "Deposit",
"type": "CREDIT",
"channel": null,
"method": null,
"currency": "NGN",
"createdAt": "2024-04-27T02:04:27.274Z",
"updatedAt": "2024-04-27T02:04:27.274Z",
"businessId": "",
"reference": "",
"depositId": "",
"spendingId": null,
"refundId": null,
"topupId": null,
"tuitionId": null,
"walletId": "",
"cardId": null,
"swapId": null,
"balance": null,
"refund": null,
"topup": null,
"spending": null,
"deposit": {
"id": "",
"currency": "NGN",
"amount": 1000,
"fee": 0,
"amountSent": 1000,
"status": "PENDING",
"depositType": "BANK_TRANSFER",
"createdAt": "2024-04-27T02:04:27.274Z",
"updatedAt": "2024-04-27T02:04:27.274Z",
"provider": null,
"providerId": ""
},
"billPayment": null,
"swap": null
}
],
"meta": {
"size": 2,
"totalItems": 2,
"nextPage": 0,
"previousPage": 0
}
}
}