Skip to main content
GET
Beneficiaries list

Authorizations

ApiKey
string
header
required

The service account's API key.

Nonce
string
header
required

A GUID, single-use. A replayed nonce is rejected.

Signature
string
header
required

Base64 RSA/SHA-256 (PKCS#1 v1.5) signature over the canonical string: METHOD, path, canonical query, Timestamp, Nonce, API secret and the lowercase hex SHA-256 of the raw body, joined with LF. Sign the PUBLIC path exactly as called (e.g. /v1/webhooks), not any internal path.

Timestamp
string
header
required

Unix seconds. Rejected outside the server's tolerance window.

Query Parameters

page
integer<int32>
pageSize
integer<int32>
id
string<uuid>
createdAt
string<date-time>
accountType
enum<string>
Available options:
Iban,
WalletAddress
rail
enum<string>
Available options:
Sepa,
Swift,
Wallet
beneficiaryName
string
alias
string
name
string
isAccountOwner
boolean
sortBy
enum<string>
Available options:
Id,
CreatedAt,
AccountType,
BeneficiaryName,
Alias,
DisplayName,
Rail
sortDirection
enum<string>
Available options:
Ascending,
Descending

Response

OK

hasNextPage
boolean
hasPreviousPage
boolean
items
object[]
pageNumber
integer<int32>
pageSize
integer<int32>
totalCount
integer<int32>
totalPages
integer<int32>