Get an Account Statement

GET accounts/statement

Description

Generate a statement for a user account within a specified date range.

Query Parameters

Name	Type	Description
accountId*	string	(Required). Account identifier. Include in the request query parameters.
startDate*	string	(Required). Start date for the statement period in the format 'yyyy-mm-dd'. Include in the request query parameters.
endDate*	string	(Required). End date for the statement period in the format 'yyyy-mm-dd'. Include in the request query parameters.
pageNumber*	integer	(Required). Page number for paginating the statement results. Include in the request query parameters.
pageSize*	integer	(Required). Number of transactions per page in the statement results. Include in the request query parameters.

Response Code: 200 - OK

Description

Account statement generation successful.

Response Field

Field	Type	Description
status	boolean	Indicates the overall success of the operation.
statusCode	integer	Represents the specific status code for the response.
message	string	Provides additional information about the response.
data	object	Contains the main data payload of the response.
errors	array	An array containing error details if issues occurred.
- message	string	Describes the error.
- descriptiveMessage	string	Provides a more detailed and descriptive message about the error.

Example

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

---

Response Code: 400 - Bad Request

Description

Invalid account id.

Example

<response>
  <status>false</status>
  <statusCode>400</statusCode>
  <message>Invalid account id</message>
  <data></data>
  <errors>
    <error>
      <message>Invalid account id</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

curlUrl: "accounts/statement" curlMethod: GET

Response Code: 404 - Not Found

Description

Account id not found.

Example

<response>
  <status>false</status>
  <statusCode>404</statusCode>
  <message>Account id not found</message>
  <data></data>
  <errors>
    <error>
      <message>Account id not found</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

Method: GET

>http://20.87.230.105/platform/wallets/accounts/statement

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string