Get Beneficiary Filters

post

https://your_connector_url/customers/{customerId}/clients/{clientId}/beneficiaries/filters

Returns the available filters for beneficiary operations (payments, beneficiary listing, and beneficiary creation). The response includes the permitted asset types (currencies) and countries based on the source account characteristics. This allows the client to filter beneficiaries by supported currencies and countries according to the integration's business rules.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

clientId

string

required

Body Params

sourceAccountId

string

Unique identifier of the source account. This field allows integrations to filter beneficiaries based on the specific source account, particularly useful for deposit accounts that cannot perform foreign exchange transactions. If not provided, the filter behaves as usual without account-specific restrictions.

sourceAssetType

string

enum

The asset type (currency) of the source account from which payments will be made

canSeeFxPayments

boolean

required

Indicates whether the customer can perform foreign exchange (FX) payments

accountCountry

string

enum

The country of the account, used to determine beneficiary creation restrictions based on regional regulations

Allowed:

ownAccount

boolean

required

Indicates whether the filter is for the customer's own accounts (true) or for external beneficiaries (false)

Responses

404

CUSTOMER_NOT_FOUND

200Successful operation