> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# List Mercury Recipients

List all saved payment recipients in the connected Mercury account. Returns each recipient's ID, name, status, emails, default payment method, and ACH/wire routing details with account numbers reduced to last-4. Ideal for: matching an invoice vendor against existing recipients before paying, vendor lookups, payment audits.

![List Mercury Recipients logo](https://ai-icon.b3.fun/logo/mercury)
Catalog action Integrations mercury

List all saved payment recipients in the connected Mercury account. Returns each recipient's ID, name, status, emails, default payment method, and ACH/wire routing details with account numbers reduced to last-4. Ideal for: matching an invoice vendor against existing recipients before paying, vendor lookups, payment audits.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `mercury-list-recipients` |
| Category | Integrations |
| Connector | `mercury` |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `mercury`, `banking`, `fiat`, `payment`, `invoicing`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `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 |
| --- | --- | --- | --- |
| `recipients` | `array` | Yes | All payment recipients saved in the Mercury account |
| `count` | `number` | Yes | Number of recipients returned \(after paginating across all pages\) |
| `total` | `number \| null` | No | Total recipients reported by Mercury across all pages, or null when the API omits it. Compare with 'count' to verify completeness. |

## Examples

**Workflow node**

```json
{
  "type": "mercury-list-recipients",
  "payload": {
    "apiKey": "configured-in-b3os"
  },
  "children": [],
  "connector": {
    "type": "mercury",
    "id": "conn_mercury"
  }
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/mercury-list-recipients/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "apiKey": "configured-in-b3os"
  }
}'
```

**Use expressions for dynamic values**

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.