---
title: List all transactions
slug: list-all-transactions
docTags:
createdAt: 2023-11-16T12:57:54.958Z
---
{
"id": "23zhJzwxF1BKOD0VkwOBY",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "/client/v1/transaction",
"name": "List all transactions",
"description": "The document explains how to retrieve all transactions attached to a business. The API allows for different filters such as status, type and date. The response from the API call includes a message indicating that the transactions have been retrieved, along with an array of details all transactions.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"kind": "required",
"name": "X-CLIENT-ID",
"type": "string",
"description": "Your client ID"
},
{
"kind": "required",
"name": "X-SIGNATURE",
"type": "string",
"description": "The base64 encoded signature"
},
{
"kind": "required",
"name": "X-TIMESTAMP",
"type": "string",
"description": "The timestamp"
},
{
"kind": "required",
"name": "X-NONCE",
"type": "string",
"description": "The Nonce"
}
],
"queryParameters": [
{
"kind": "optional",
"name": "status",
"type": "string",
"description": "Transaction status to search for"
},
{
"kind": "optional",
"name": "currency",
"type": "string",
"description": "Currency to search for"
},
{
"kind": "optional",
"name": "type",
"type": "string",
"description": "Transaction type to search for"
},
{
"kind": "optional",
"name": "start_date",
"type": "string",
"description": "Date to start searching from eg 2006-01-02
"
},
{
"kind": "optional",
"name": "end_date",
"type": "string",
"description": "Date to end searching for eg 2006-01-02
"
},
{
"kind": "optional",
"name": "offset",
"type": "integer",
"description": "Pagination offset"
},
{
"kind": "optional",
"name": "limit",
"type": "integer",
"description": "Pagination limit, default value is 50
"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "transactions retrieved",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "transactions retrieved",
"customType": "clientApi.ListTransactionRequestSuccessful",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "array",
"modelRef": "#/definitions/clientApi.Transaction",
"customType": "clientApi.Transaction[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "Unique identifier for the transaction.",
"example": ""
},
{
"name": "business_id",
"kind": "optional",
"type": "string",
"description": "Unique business identifier that owns the transaction.",
"example": ""
},
{
"name": "amount",
"kind": "optional",
"type": "number",
"description": "A positive integer in currency representing how much was deducted (This includes any associated fees).",
"example": ""
},
{
"name": "exchange_amount",
"kind": "optional",
"type": "number",
"description": "A positive integer in the exchange currency representing how much was sent to the recipient.",
"example": ""
},
{
"name": "exchange_rate",
"kind": "optional",
"type": "string",
"description": "A positive integer in kobo representing how much was exchanged.",
"example": ""
},
{
"name": "currency",
"kind": "optional",
"type": "string",
"description": "A Three-letter ISO currency code for the amount",
"example": ""
},
{
"name": "exchange_currency",
"kind": "optional",
"type": "string",
"description": "A Three-letter ISO currency code for the exchange amount",
"example": ""
},
{
"name": "fee_amount",
"kind": "optional",
"type": "number",
"description": "A fee deducted from the amount",
"example": ""
},
{
"name": "account_number",
"kind": "optional",
"type": "string",
"description": "Recipient account number",
"example": ""
},
{
"name": "bank_code",
"kind": "optional",
"type": "string",
"description": "Recipient bank code. This is usually a Zide bank code and starts with `ZIDE`",
"example": ""
},
{
"name": "bank_name",
"kind": "optional",
"type": "string",
"description": "Recipient bank name",
"example": ""
},
{
"name": "recipient_name",
"kind": "optional",
"type": "string",
"description": "Recipient name",
"example": ""
},
{
"name": "recipient_phone",
"kind": "optional",
"type": "string",
"description": "Recipient phone",
"example": ""
},
{
"name": "recipient_country",
"kind": "optional",
"type": "string",
"description": "Recipient country",
"example": ""
},
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "Transaction type",
"example": ""
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "Transaction status",
"example": ""
},
{
"name": "service_name",
"kind": "optional",
"type": "string",
"description": "Service name. Describes what the transaction is",
"example": ""
},
{
"name": "narration",
"kind": "optional",
"type": "string",
"description": "An arbitrary string that is attached to the transaction by the sender",
"example": ""
},
{
"name": "created_by",
"kind": "optional",
"type": "string",
"description": "Unique reference identifier of the client that created the transaction",
"example": ""
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"description": "Date time string of when transaction was created",
"example": ""
},
{
"name": "completed_at",
"kind": "optional",
"type": "string",
"description": "Date time string of when transaction was completed",
"example": ""
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"description": "Date time string of when transaction was last updated",
"example": ""
}
]
},
{
"name": "meta",
"kind": "optional",
"type": "object",
"example": "",
"schema": [
{
"name": "total_count",
"kind": "optional",
"type": "number",
"example": ""
}
]
},
{
"name": "message",
"kind": "optional",
"type": "string",
"example": "",
"default": "transaction retrieved"
}
],
"modelRef": "#/definitions/clientApi.ListTransactionRequestSuccessful",
"isExpanded": true
}
]
}
],
"examples": {
"languages": [
{
"id": "kAu-BPGu_OJY-axt4flW4",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url /client/v1/transaction \\\n --header 'accept: application/json' \\\n --header 'x-client-id: string' \\\n --header 'x-signature: string' \\\n --header 'x-timestamp: string' \\\n --header 'x-nonce: string'"
},
{
"id": "7xON9W5w_t1t2P8Gody1r",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-client-id\", \"string\");\nmyHeaders.append(\"x-signature\", \"string\");\nmyHeaders.append(\"x-timestamp\", \"string\");\nmyHeaders.append(\"x-nonce\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/client/v1/transaction\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "0tGLB4s3EW_672ejQOmch",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/client/v1/transaction\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-client-id\"] = \"string\"\nrequest[\"x-signature\"] = \"string\"\nrequest[\"x-timestamp\"] = \"string\"\nrequest[\"x-nonce\"] = \"string\"\n\nresponse = http.request(request)\nputs response.read_body\n"
},
{
"id": "6KAUxE-uwi8yUTmc2T5sa",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"/client/v1/transaction\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-client-id': 'string',\n 'x-signature': 'string',\n 'x-timestamp': 'string',\n 'x-nonce': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "kAu-BPGu_OJY-axt4flW4"
},
"results": {
"languages": [
{
"id": "eA81SlKYWt_RcPWsGrTsI",
"language": "200",
"code": "// transactions retrieved\n{\n \"data\": [\n {\n \"id\": \"\",\n \"business_id\": \"\",\n \"amount\": 0,\n \"exchange_amount\": 0,\n \"exchange_rate\": \"\",\n \"currency\": \"\",\n \"exchange_currency\": \"\",\n \"fee_amount\": 0,\n \"account_number\": \"\",\n \"bank_code\": \"\",\n \"bank_name\": \"\",\n \"recipient_name\": \"\",\n \"recipient_phone\": \"\",\n \"recipient_country\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"service_name\": \"\",\n \"narration\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"total_count\": 0\n },\n \"message\": \"\"\n}"
}
],
"selectedLanguageId": "eA81SlKYWt_RcPWsGrTsI"
}
},
"children": [
{
"text": ""
}
]
}