get https://api.cardda.com/v1/banking/bank_recipients
Returns a paginated list of bank recipients (beneficiaries) configured for your bank accounts.
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 asrecipient_id
when creating transactions - Recipients must be in
approved
status to receive transfers - Some banks require authorization tokens when creating recipients
- The
owner_id
refers to the bank account that owns this recipient
Recipient Status Values
draft
- Recipient created but not enrolled in bankenrolling
- Enrollment in progressapproved
- Ready to receive transfersdeclined
- Enrollment failed or recipient blocked