mercury_list_recipients
List payment recipients to obtain recipient IDs for sending money via ACH, wire, or check, or for auditing who can receive funds.
Instructions
List all payment recipients (counterparties for outbound ACH/wire/check) in your Mercury workspace.
USE WHEN: enumerating recipients before sending money — need a recipientId to feed into mercury_send_money or mercury_request_send_money. Also useful for an audit of who can receive funds from this account.
DO NOT USE: for AR customers (use mercury_list_customers — different surface, different scope). Recipients are bank-payment counterparties; customers are who you invoice.
RETURNS: { recipients: [{ id, name, nickname, defaultPaymentMethod, electronicRoutingInfo, status, ... }] }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||