Skip to main content

Fetch bank statement

GET /api/v1/BankStatement/fetch?id=<string>&months=<integer>

Description

This endpoint is used to fetch bank statements for a specified period of time, with a maximum of 12 months.

Headers: Accept-Language: optional, allows changing default response message language, type: string

Content-Type:

  • text/plain
  • application/json
  • text/json

ApiKey:

  • No API key required

Request Parameters:

  • id: The identifier of the bank statement to fetch (string, required)
  • months: The number of months of bank statements to fetch (integer, required, range: 1-12)

URL: /api/v1/BankStatement/fetch

Query Parameters: None

params:

  • id: string, required
  • months: integer, required, range: 1-12

Response: The response is a "Success" status with a code of 200.

Schema:

    cssCopy code[  {    "id": "1",    "transaction": "ATM Withdrawal",    "date": "2023-02-18T12:12:12.000Z",    "amount": "25.00"  }]

Error Codes:

  • 400: Bad Request
  • 404: Resource not found
  • 500: Internal server error

Example:

    bashCopy codeGET /api/v1/BankStatement/fetch?id=1&months=3

Response:

    cssCopy codeHTTP/1.1 200 OK
[ { "id": "1", "transaction": "ATM Withdrawal", "date": "2023-02-18T12:12:12.000Z", "amount": "25.00" }]

Headers


Accept-Language Change default response message language from English(en). Available languages fr,en

Accept text/plain

PARAMS


id <string> months <integer>