mercury_update_recipient
Update an existing payment recipient (legal name, nickname, contact emails, default payment method).
Instructions
Update an existing payment recipient (legal name, nickname, contact emails, default payment method).
USE WHEN: amending a recipient's contact info or default payment method after creation. Useful for re-routing future payments to a recipient via a different method (e.g. ACH → wire) without recreating it.
DO NOT USE: to change the bank account number / routing number — that requires a fresh recipient (security policy on Mercury's side). Use mercury_add_recipient for the new banking info.
SIDE EFFECTS: writes the recipient record on Mercury. Persistent. Only the fields you pass are changed. Mercury endpoint is POST /recipient/{id} (SINGULAR — not the plural /recipients/{id}).
RETURNS: { id, name, nickname, defaultPaymentMethod, ... } — the updated recipient.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Recipient legal name | |
| emails | No | List of email addresses | |
| nickname | No | Internal nickname | |
| recipientId | Yes | The recipient ID | |
| contactEmail | No | Primary contact email | |
| defaultPaymentMethod | No |