API Documentation

Get cash accounts details by filter

post
https://apim.demo01.my.fivedegrees.cloud/sbx/cash-accounts/filter

API endpoint to get details of filtered range of cash account.

Body Params

The account details filters

int32 | null

Internal identifier of the department.

int32 | null

Internal identifier of the unit.

int32 | null

External Portfolio Id, the Id the external system uses to identify portfolio.

string | null

The currency of the account, based on ISO 4217. In the reference data endpoint 'currencies' an user can get the full list of available values.

date-time | null

Format - date-time (as date-time in RFC3339). The created date of the payment message. Note: if the date is provided without timestamp (date format, i.e. 2023-08-28) - then time part will be considered as T00:00:00.0000000+00:00.

date-time | null

Format - date-time (as date-time in RFC3339). The created date of the payment message. Note: if the date is provided without timestamp (date format, i.e. 2023-08-28) - then time part is considered as T00:00:00.0000000+00:00, which means that none of the payment messages for this date will be returned. If this field is filled in the date format, and it is expected to get the payment messages for the chosen end date: insert chosen date+1 day.

string | null

The account identification.

serviceBehaviors
array of int32s | null

Indicates the behaviour of the account - i.e. counter account, error account.

serviceBehaviors
int32 | null

Status of the movement. The list of available movement states can be retrieved by using reference data endpoint: /accounts-reference-data/movement-statuses.

int32 | null

Leading feature of the account, i.e. cash account or term deposit feature.

boolean | null

Indicates if internal accounts should be listed. If set to: true - internal accounts will be listed; false - internal accounts will not be listed; NULL - no filtering for this parameter will be done.

boolean | null

Used for filtering of the accounts with: balance different then zero - if set to false; balance equal to zero - if set to true; regardless of the balance - if set to NULL.

string | null

The property to be used in ordering the response.

int32

The Page Number

int32

The Page Size

Headers
string
required
Defaults to v1

API versioning

uuid
required
Defaults to 2fe65b05-7ad4-438a-84e9-280749f8f43a

Correlates HTTP requests between a client and server

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

500

Internal Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated 3 months ago

Did this page help you?