Actions46
- Attachment Actions
- Attachments in a Transaction Actions
- Beneficiary Actions
- Card Actions
- Client Actions
- Client Invoice Actions
- Credit Note Actions
- External Transfer Actions
- Insurance Contract Actions
- Internal Transaction Actions
- Label Actions
- Membership Actions
- Organization Actions
- Request Actions
- Statement Actions
- Supplier Invoice Actions
- Team Actions
- Transaction Actions
Beneficiary → List Beneficiaries
AI-generatedOverview
This node interacts with the Qonto API to list beneficiaries based on specified filters and pagination options. It is useful for retrieving a list of beneficiaries associated with a Qonto account, allowing users to filter results by IBAN, status, trusted status, and update date ranges. This operation supports returning all results or limiting the number of results returned, making it practical for managing and reviewing beneficiary data efficiently.
Use Case Examples
- Retrieve all beneficiaries with a specific IBAN.
- List beneficiaries filtered by status such as 'pending' or 'validated'.
- Get a limited number of beneficiaries updated within a specific date range.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use for the API request, either Login and Secret-Key or OAuth2. |
| Return All | Whether to return all beneficiary results or limit the number of results. |
| Limit | Maximum number of beneficiary results to return when 'Return All' is false. |
| Filters | Filters to apply when listing beneficiaries, including IBAN, status, trusted status, and update date range. |
Output
JSON
id- Unique identifier of the beneficiary.name- Name of the beneficiary.iban- IBAN of the beneficiary.status- Status of the beneficiary (e.g., pending, validated, declined).trusted- Boolean indicating if the beneficiary is trusted.updated_at- Timestamp of the last update to the beneficiary.
Dependencies
- Qonto API
Troubleshooting
- Ensure correct authentication method and credentials are provided; authentication errors may occur otherwise.
- Verify filter values are valid and formatted correctly to avoid API request errors.
- If 'Return All' is false, ensure 'Limit' is set to a positive integer to avoid invalid parameter errors.
- Network or API downtime may cause request failures; retry or check Qonto API status.
Links
- Qonto API - List Beneficiaries - Official Qonto API documentation for listing beneficiaries with available filters and parameters.