Get Mercury Recipient
Fetch a single Mercury payment recipient by ID. Returns the recipient's name, status, emails, default payment method, and ACH/wire routing details with account numbers reduced to last-4. Ideal for: verifying recipient details before sending a payment, confirming routing info matches an invoice.
Catalog action Integrations mercury
Fetch a single Mercury payment recipient by ID. Returns the recipient's name, status, emails, default payment method, and ACH/wire routing details with account numbers reduced to last-4. Ideal for: verifying recipient details before sending a payment, confirming routing info matches an invoice.
At a Glance
| Field | Value |
|---|---|
| Action ID | mercury-get-recipient |
| Category | Integrations |
| Connector | mercury |
| Requires gas | No |
| Funds movement | None declared |
| Tags | mercury, banking, fiat, payment, invoicing, read |
Payload Schema
| Field | Type | Required | Description |
|---|---|---|---|
recipientId | string | Yes | Mercury recipient ID (from mercury-list-recipients) |
apiKey | string | No | Mercury API token. Normally injected automatically by the 'mercury' connector — only set this to override the connector's token. |
Result Schema
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Mercury recipient ID — pass this to payment actions |
name | string | Yes | Recipient legal name |
nickname | string | null | No | Recipient nickname |
status | string | Yes | Recipient status (e.g. 'active', 'deleted') |
emails | array | Yes | Email addresses notified when the recipient is paid |
defaultPaymentMethod | string | null | No | Default payment method (e.g. 'ACH', 'Check', 'DomesticWire') |
dateLastPaid | string | null | No | ISO timestamp of the last payment to this recipient |
ach | object | null | No | ACH (electronic) routing details, or null if not configured |
domesticWire | object | null | No | Domestic wire routing details, or null if not configured |
Examples
json{ "type": "mercury-get-recipient", "payload": { "recipientId": "0x0000000000000000000000000000000000000000" }, "children": [], "connector": { "type": "mercury", "id": "conn_mercury" }}
bashcurl -X POST "https://api.b3os.org/v1/actions/mercury-get-recipient/test" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "inputs": { "recipientId": "0x0000000000000000000000000000000000000000" }}'
Payload fields can use workflow expressions such as {{$trigger.body.amount}}, {{$nodes.fetch.result.price}}, and {{$props.asset}} when the value should come from a trigger, prior node, or reusable workflow prop.