Overview

This node operation lists beneficiaries, allowing users to retrieve a paginated list of beneficiary records. It supports filtering by currency and pagination controls such as page number and records per page. This is useful for scenarios where users need to manage or review their beneficiaries in a currency transfer system, for example, to display beneficiaries in a user interface or to process payments to selected beneficiaries.

Use Case Examples

1. Retrieve the first page of beneficiaries with default 25 records per page.
2. List beneficiaries filtered by specific currencies to narrow down the results.

Properties

Output

JSON

• beneficiaries - Array of beneficiary records returned from the list operation.
• pagination
  • page - Current page number of the results.
  • perPage - Number of records per page in the results.
  • totalPages - Total number of pages available.
  • totalRecords - Total number of beneficiary records available.

Dependencies

• An API key credential for authentication to the currency transfer API.

Troubleshooting

• Common issues include invalid page numbers or per page values causing empty or error responses. Ensure page and per page inputs are valid positive integers.
• Filtering by unsupported or invalid currencies may result in no data returned.
• Timeouts or SSL certificate issues can occur; use the request options to adjust timeout or allow insecure certificates if necessary.