GET
/
api
/
v1
/
beneficiaries
List Beneficiaries with Filtering
curl --request GET \
  --url http://localhost:8080/api/v1/beneficiaries
[
  {
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display": true,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "account_number": "<string>",
    "address": "<string>",
    "bank_address": "<string>",
    "bank_name": "<string>",
    "bic": "<string>",
    "city": "<string>",
    "country_code": "<string>",
    "iban": "<string>",
    "postal_code": "<string>",
    "routing_number": "<string>",
    "swift_code": "<string>"
  }
]

Query Parameters

​
limit
integer<int64> | null

Maximum number of results (default: 50, max: 100)

​
offset
integer<int64> | null

Number of results to skip

​
client_id
string<uuid> | null

Filter by client ID

​
beneficiary_type
null | enum<string>

Filter by beneficiary type Beneficiary Type - Individual person or company

Available options:
PERSON,
COMPANY
​
country_code
string | null

Filter by country code (ISO 3166-1 alpha-3)

​
display
boolean | null

Filter by display status

​
search
string | null

Search in name, IBAN, account_number

Response

List of beneficiaries

​
beneficiary_type
enum<string>
required

Beneficiary Type - Individual person or company

Available options:
PERSON,
COMPANY
​
client_id
string<uuid>
required
​
created_at
string<date-time>
required
​
display
boolean
required

Whether beneficiary is displayed to users

​
id
string<uuid>
required
​
name
string
required

Beneficiary name (person or company name)

​
updated_at
string<date-time>
required
​
account_number
string | null

Bank account number (non-SEPA)

​
address
string | null
​
bank_address
string | null

Bank address

​
bank_name
string | null

Bank name

​
bic
string | null

Bank Identifier Code (SEPA)

​
city
string | null
​
country_code
string | null

ISO 3166-1 alpha-3 country code

​
iban
string | null

International Bank Account Number (SEPA)

​
postal_code
string | null
​
routing_number
string | null

US ABA routing number

​
swift_code
string | null

SWIFT code for international transfers