Retrieve All Accounts

GET /accounts

Description

Retrieve information about all user accounts based on specified parameters.

Query Parameters

Name	Type	Description
pageNumber	integer($int32)	(Optional). Page number for pagination. Include in the query parameters.
pageSize	integer($int32)	(Optional). Number of records per page. Include in the query parameters.
currencies	array[string]	(Optional). Filter accounts by currency. Include in the query parameters.
types	array[string]	(Optional). Filter accounts by type (e.g., "SAVINGS", "CHECKING"). Include in the query parameters.
userProfileIds	array[string]	(Optional). Filter accounts by user profile IDs. Include in the query parameters.
walletUserIds	array[string]	(Optional). Filter accounts by wallet user IDs. Include in the query parameters.
categories	array[string]	(Optional). Filter accounts by categories. Include in the query parameters.
providers	array[string]	(Optional). Filter accounts by providers. Include in the query parameters.
startDate	string($date-time)	(Optional). Start date for filtering accounts. Include in the query parameters.
endDate	string($date-time)	(Optional). End date for filtering accounts. Include in the query parameters.

Response Code: 200 - OK

Description

Accounts returned successfully.

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" 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/businesses

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string