POST
/
account
/
statement
curl --request POST \
  --url https://devapi.withedge.co/gateway/api/v1/account/statement \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'requestId: <requestid>' \
  --data '{
  "startDate": "<string>",
  "endDate": "<string>",
  "accountNumber": "<string>"
}'
{
	"statusCode": 00,
	"message": "Account Statement Successfully Retrieved",
	"data": {
		"accountNumber": "5118745523",
		"customerId": "7090806397",
		"openingBalance": "530,840.95",
		"closingBalance": "570,835.65",
		"transactions": [
			{
				"amount": "10,005.30",
				"narration": "transaction description",
				"type": "Debit",
				"date": "dd/mm/yyy"
			},
			{
				"amount": "50,000",
				"narration": "transaction description",
				"type": "Credit",
				"date": "dd/mm/yyy"
			}
		]
		"currentPage": 1,
		"pageSize": 10,
		"previousPage": 0,
		"total": 2
	},
	"errors": [],
}

​
Get Account Statement

This endpoint allows you to fetch the statement of a customer’s account within a specified date range.

​
Request Parameters

​
requestId
string
required

A unique identifier for the request. It is used for idempotency, ensuring that repeated requests with the same requestId are not processed multiple times.
Example: e0b9f8d0-7a57-4a67-a8b2-4d7c7b5a37c9

​
accountNumber
string
required

The unique account number of the user or entity. This is required to specify the account that the request is targeting.
Example: 5118745523

​
page
integer
required

The page number to retrieve in paginated responses. Use this to specify which set of results should be returned.
Example: 1

​
pageSize
integer
required

The number of results to return per page. This controls the size of each paginated response.
Example: 10

​
startDate
string
required

The start date for filtering data, typically in YYYY-MM-DD format. This defines the beginning of the date range for the query.
Example: 2024-01-01

​
endDate
string
required

The end date for filtering data, typically in YYYY-MM-DD format. This defines the end of the date range for the query.
Example: 2024-01-31

​
accountNumber
string
required

The account number provided in the request body, used to specify the account relevant to the query or operation.
Example: 5118745523

{
	"statusCode": 00,
	"message": "Account Statement Successfully Retrieved",
	"data": {
		"accountNumber": "5118745523",
		"customerId": "7090806397",
		"openingBalance": "530,840.95",
		"closingBalance": "570,835.65",
		"transactions": [
			{
				"amount": "10,005.30",
				"narration": "transaction description",
				"type": "Debit",
				"date": "dd/mm/yyy"
			},
			{
				"amount": "50,000",
				"narration": "transaction description",
				"type": "Credit",
				"date": "dd/mm/yyy"
			}
		]
		"currentPage": 1,
		"pageSize": 10,
		"previousPage": 0,
		"total": 2
	},
	"errors": [],
}

Was this page helpful?

Get Account DetailsGet All Accounts