API Reference
Create AccountLogin

List beneficiaries

get
https://sandbox-api.oneliquidity.technology/fcat/v1/beneficiaries

Returns active beneficiaries and supports filtering by name, type, payment classification, currency, bank, status, and date.

limit is the maximum number of matching beneficiaries returned and defaults to 100. When a response contains lek, send that UUID back unchanged as lek with the same filters to request the next page. Omit lek on the first request and after the final page.

Query Params
string

Search string (account name or part of account name)

string
enum

The beneficiary currency

Allowed:
uuid

Beneficiary UUID returned as lek by the previous page. Send it back unchanged and keep the original filters the same.

integer
1 to 100
Defaults to 100

Maximum number of matching beneficiaries to return. Defaults to 100.

string
enum

Filter by beneficiaryType

Allowed:
string
enum

Filter by whether the beneficiary owns the account or is a third party.

Allowed:
date-time

Start of the date range in ISO 8601 format. Supply together with endDate.

date-time

End of the date range in ISO 8601 format. Supply together with startDate.

string

Bank Code

string
enum

query interval

Allowed:
string
enum

The beneficiary status

Allowed:
Responses

Updated 4 days ago

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

Updated 4 days ago

Did this page help you?