Customer Account Statement

To retrieve a customer account statement, send a GET request to the following endpoint: GET /api/Report/v1/RequestCustomerAccountStatement A successful request will return the customer's account statement with relevant information, such as the balance, transaction history, and account details. This process enables the retrieval of customer account statements, providing access to essential financial information for both customers and the organization.

Headers

Name
Value

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Query Parameter

Name
Data Type (length)
Description

accountNumber

string

The customer's account number

financialDateFrom

date

Start date of financial activity

financialDateto

date

End date of financial activity

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g '{{baseurl}}/api/Report/v1/RequestCustomerAccountStatement?AccountNumber=1000029938&FinancialDateFrom=2022-01-01&FinancialDateTo=2022-03-09' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''
Respose: 200
{
  "status": true,
  "message": "string",
  "data": {
    "data": [
      {
        "financialDate": "string",
        "transactionDate": "2023-01-29T15:12:46.861Z",
        "accountNumber": "string",
        "postingReferenceNumber": "string",
        "debit": 0,
        "credit": 0,
        "narration": "string",
        "balance": 0
      }
    ],
    "accountNumber": "string",
    "accountName": "string",
    "address": "string",
    "passportFileUrl": "string",
    "product": "string",
    "openingBalance": 0,
    "closingBalance": 0,
    "totalCredit": 0,
    "totalDebit": 0,
    "recordCount": 0
  }
}

Last updated