Skip to main content

Generate Bank Statement

POST /openbanking/statement/{bankCode}

Description

Generates a bank statement for a specific account within a specified date range. This endpoint requires authorization and identification headers to authenticate the request.

Path Parameters:

NameTypeDescription
bankCodestringThe code of the bank for which the statement is to be generated. Required.

Headers:

NameTypeDescription
tenantIdstringThe unique identifier of the tenant. Required.
countryCodestringThe country code associated with the bank account. Required.
userIdstringThe unique identifier of the user. Required.

Request Body:

NameTypeDescription
accountNumberstringThe account number for which the statement is to be generated. Required.
startDatestringThe start date for the statement in YYYY-MM-DD format. Required.
endDatestringThe end date for the statement in YYYY-MM-DD format. Required.

Sample Request Body:

{
"accountNumber": "1234567890",
"startDate": "2024-11-01",
"endDate": "2024-11-28"
}

Sample Response

{
"status": true,
"statusCode": 0,
"message": "Bank statement generated successfully",
"data": {},
"errors": [
{
"message": "Optional error message",
"data": {},
"descriptiveMessage": "Detailed error description"
}
]
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request POST \ 
--url /openbanking/statement/{bankCode} \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!