Returns a paginated list of bank recipients (beneficiaries) configured for your bank accounts.

🚧

Recipients are per bank account, not per company. A recipient belongs to exactly one

bank_account (its owner_id). The same person enrolled in two of your accounts is two
different recipients, with two different ids. Before creating a transfer, look the recipient
up scoped to the account that pays — ?owner_id={sender_id} — never by name alone:
passing a recipient from another account fails with
422 "Recipient must belong to same account as transaction".

The per-field operators in Filters — $gt, $gte,
$lt, $lte, $in, $nin, $ne, $regex — are supported on the columns listed in
Query parameters, passed as the value of that column (?alias={"$regex":"proveedor"}).
The set is the same for every listable resource; the inclusive comparisons $gte / $lte
are available here too, they are just of little use on this resource's mostly-textual
columns. A bare value is an exact match; use {"$regex": "..."} for partial,
case-insensitive matching.

$or is not a per-field operator: it is a separate top-level query parameter taking an
array of filter objects (?$or=[{"alias":{"$regex":"abc"}},{"name":{"$regex":"abc"}}]), so it
does not belong inside a field filter — see the $or parameter below and
Logical OR operations.

Common Use Cases

Finding a Recipient by Name or Alias

To find recipients by their alias (commonly used identifier):

GET /v1/banking/bank_recipients?alias=proveedor-abc

Finding Recipients by RUT

To find all recipients with a specific RUT:

GET /v1/banking/bank_recipients?rut=761234567

Finding Recipients for a Specific Bank Account

To list recipients associated with a specific bank account:

GET /v1/banking/bank_recipients?owner_id=456e7890-a12b-34c5-d678-901234567890

Finding Recipients by Status

To filter by approval status:

GET /v1/banking/bank_recipients?status=approved

Finding Recipients by Bank

To list all recipients from a specific bank:

GET /v1/banking/bank_recipients?bank_id=cl_banco_estado

Pagination and Sorting

GET /v1/banking/bank_recipients?_start=0&_end=50&_order=desc&_field=created_at

Important Notes

• The id field in the response is what you'll use as recipient_id when creating transactions
• owner_id is the bank account this recipient belongs to. A transfer only accepts a recipient
  whose owner_id equals the transfer's sender_id
• Recipients must be in approved status to receive individual transfers; a payroll transfer
  accepts any status except deleted
• Some banks require authorization tokens when creating recipients
• recipient_account_id is an internal field returned only to Cardda administrators;
  company users won't see it in the index/show responses

Recipient Status Values

• draft - Recipient created but not enrolled in bank
• enrolled - Enrolled at the bank
• preauthorized - Preauthorized, awaiting final authorization
• deleted - Soft-deleted recipient
• approved - Ready to receive transfers