GET
/
v1
/
accounts
/
{account_number}
/
transactions
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts/{account_number}/transactions \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "transaction fetched successfully",
  "data": {
    "transactions": [
      {
        "wasReversed": false,
        "amount": 20050,
        "description": "Transfer from Gabriel Fuja (TRF/2000/10009/0001) ",
        "category": "Fund Transfer",
        "uniqueRef": "203018641660868",
        "internalRef": "991042",
        "transactionType": "DEBIT",
        "entryDate": "2024-02-20T13:18:40.000+0000",
        "updatedDate": "2024-02-20T13:18:42.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 833340
      },
      {
        "wasReversed": false,
        "amount": 105550,
        "description": "Transfer from CARBON BUSINESS DEMO (Testing XPS FT API via Postman 01)",
        "category": "Fund Transfer",
        "uniqueRef": "204713729240845",
        "internalRef": "991033",
        "transactionType": "DEBIT",
        "entryDate": "2024-02-20T12:23:56.000+0000",
        "updatedDate": "2024-02-20T12:23:58.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 853390
      },
      {
        "wasReversed": false,
        "amount": 20000,
        "description": "Transfer from Gabriel Fuja (TRF/2000/10009/0001) ",
        "category": "Fund Transfer",
        "uniqueRef": "209421508033615",
        "internalRef": "991020",
        "transactionType": "DEBIT",
        "entryDate": "2024-02-20T08:30:55.000+0000",
        "updatedDate": "2024-02-20T08:31:01.000+0000",
        "internal": true,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 958940
      },
      {
        "wasReversed": false,
        "amount": 20000,
        "description": "Transfer from Gabriel Fuja (TRF/2000/10009/0001) ",
        "category": "Fund Transfer",
        "uniqueRef": "201195904386519",
        "internalRef": "991018",
        "transactionType": "DEBIT",
        "entryDate": "2024-02-20T08:30:17.000+0000",
        "updatedDate": "2024-02-20T08:30:22.000+0000",
        "internal": true,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 978940
      },
      {
        "wasReversed": false,
        "amount": 15050,
        "description": "Transfer from CARBON BUSINESS DEMO (Testing XPS FT API via Postman 01)",
        "category": "Fund Transfer",
        "uniqueRef": "206403559607164",
        "internalRef": "987990",
        "transactionType": "DEBIT",
        "entryDate": "2024-02-17T06:14:42.000+0000",
        "updatedDate": "2024-02-17T06:14:43.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 998940
      },
      {
        "wasReversed": false,
        "amount": 10050,
        "description": "Transfer from CARBON BUSINESS DEMO (Testing XPS FT API via Postman 01)",
        "category": "Fund Transfer",
        "uniqueRef": "200020180255668",
        "internalRef": "987987",
        "transactionType": "DEBIT",
        "entryDate": "2024-02-17T01:55:35.000+0000",
        "updatedDate": "2024-02-17T01:55:37.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 1013990
      },
      {
        "wasReversed": false,
        "amount": 10050,
        "description": "Transfer from CARBON BUSINESS DEMO (Testing XPS FT API via Postman 01)",
        "category": "Fund Transfer",
        "uniqueRef": "208354140652338",
        "internalRef": "987984",
        "transactionType": "DEBIT",
        "entryDate": "2024-02-17T00:00:04.000+0000",
        "updatedDate": "2024-02-17T00:00:06.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 1024040
      },
      {
        "wasReversed": false,
        "amount": 500000,
        "description": "Transfer from test demo (TRF/INTERNAL/FRM/6009490194/5649795915)",
        "category": "Fund Transfer",
        "uniqueRef": "208693256860847",
        "internalRef": "981005",
        "transactionType": "DEBIT",
        "entryDate": "2024-01-26T18:29:14.000+0000",
        "updatedDate": "2024-01-26T18:29:16.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 1034090
      },
      {
        "wasReversed": false,
        "amount": 100000,
        "description": "BUSINES BANKING DEMO",
        "category": "Wallet Topup",
        "uniqueRef": "324334544-561706293247",
        "internalRef": "981001",
        "transactionType": "CREDIT",
        "entryDate": "2024-01-26T18:20:48.000+0000",
        "updatedDate": "2024-01-26T18:20:52.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 1534090
      },
      {
        "wasReversed": false,
        "amount": 100000,
        "description": "BUSINES BANKING DEMO",
        "category": "Wallet Topup",
        "uniqueRef": "324334544-561706293195",
        "internalRef": "981000",
        "transactionType": "CREDIT",
        "entryDate": "2024-01-26T18:19:57.000+0000",
        "updatedDate": "2024-01-26T18:20:03.000+0000",
        "internal": false,
        "accountId": "6009490194",
        "externalStatus": "PENDING",
        "balance": 1434090
      }
    ],
    "last": false,
    "query": {
      "limit": 10,
      "offset": 0,
      "includeBalance": true,
      "status": [
        "SUCCESS"
      ],
      "entity": "NG"
    }
  }
}

​
Overview

This endpoint retrieves a list of transactions for a specific account.

​
HTTP Request

GET /v1/accounts/{account_number}/transactions

​
Parameters

  • Header: x-carbon-key (string, required) - API key for authentication.
  • Path:
    • account_number (integer, required) - The account number.
  • Query:
    • page (integer, optional, default=1) - The page number for paginated results.
    • limit (integer, optional, default=10) - The number of transactions per page.

​
Example Response

{
  "status": "success",
  "message": "transaction fetched successfully",
  "data": {
    "transactions": [
      {
        "wasReversed": false,
        "amount": 0,
        "description": "",
        "category": "",
        "uniqueRef": "",
        "internalRef": "",
        "transactionType": "",
        "entryDate": "",
        "updatedDate": "",
        "internal": true,
        "accountId": "",
        "externalStatus": "",
        "balance": 0
      }
    ],
    "last": true,
    "query": {
      "limit": 10,
      "offset": 0,
      "includeBalance": true,
      "status": [""],
      "entity": ""
    }
  }
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
account_number
integer
required

Query Parameters

​
page
integer
​
limit
integer

Response

200 - application/json
OK

The response is of type object.