Get beneficiaries
Authorizations
An API Key.
Query Parameters
The identifier of a client.
Filter. The account number of the beneficiary you want to search.
Filter. The iban of the account of the beneficiary you want to search.
Filter. The bank identifier of the account of the beneficiary you want to search.
Filter. Whether to return active, inactive, or all beneficiaries (no null bank accounts). Defaults to active only.
true, false, all The desired page number for pagination. By default is 1.
The number of items per page for pagination. By default is 50.
Response
Will successfully list the requested beneficiaries
True if beneficiary is active, False otherwise.
AML status of the beneficiary.
OK, Pending Review, Pending information, Blocked The list of beneficiary's bank accounts.
The identifier of the beneficiary.
Creation date of the beneficiary.
The first address line of the beneficiary.
The reference for the beneficiary.
The ISO 3166-1 alpha-2 code of the beneficiary's country.
[A-Z]{2}The list of beneficiary's email addresses.
Whether the beneficiary should receive email notification of payments.
The name of the beneficiary.
The post code of the beneficiary.