Get Statement

GET

/client-service/api/v1/statement/clientStatement/{accountNumber}

Statement

Get statement for the specified account. If no start or end date is passed, transactions from the current date are returned.

Request

Path Params

accountNumber

string

required

Account number

Query Params

startDate

string

optional

Start date (up to 6 months in the past)

endDate

string

optional

End date

limit

integer

optional

page size - int64

pageNumber

integer

optional

page offset- int64

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/statement/clientStatement/?startDate&endDate&limit&pageNumber'

Responses

🟢200OK

application/json

success response

Body

StatementOutput type

message

string

optional

Message

openingBalance

number

optional

Account balance at 00:00 UTC on the startDate

closingBalance

number

optional

Account balance at 23:59 UTC on the endDate

startDate

string

optional

Start date

endDate

string

optional

End date

statement

object

optional

Statement object

data

array [object {9}]

optional

Array of transactions

page

number

optional

Page number

pageSize

number

optional

Number of transactions on each page

totalItems

number

optional

Total number of transactions

totalPages

number

optional

Total number of pages

Example

{
  "message": "Statement retrieved successfully.",
  "openingBalance": 653563432.77,
  "closingBalance": 5893475.56,
  "startDate": "2025-01-10",
  "endDate": "2025-01-10",
  "statement": {
    "data": [
      {
        "id": "fxr_7m2ScBy6TZI6Qh",
        "amount": 43445.25,
        "currency": "NGN",
        "direction": "debit",
        "transactionType": "trade",
        "transactionDate": "2025-01-10T18:24:29.000Z",
        "narration": "NGN to USD trade",
        "customReference": "",
        "balance": 123987432.77
      },
      {
        "id": "20241126052300",
        "amount": 1000,
        "currency": "NGN",
        "direction": "debit",
        "transactionType": "transfer",
        "transactionDate": "2025-01-10T15:03:22.000Z",
        "narration": "INV-35178",
        "customReference": "",
        "balance": 123988432.77
      }
    ],
    "page": 1,
    "pageSize": 100,
    "totalItems": 9,
    "totalPages": 1
  }
}

🟠400Bad Request

🟠401Unauthorized

💰 Accounts

Create Virtual Account