Mercury - Get Recipients

Description

This module allows getting the list of recipients configured in Mercury or the details of a specific recipient, including bank information and payment method.

Configuration

Field	Type	Required	Description
credentials_id	credential	Yes	Mercury credentials
recipient_id	string	No	Specific recipient ID
limit	number	No	Results limit (default: 50)
offset	number	No	Offset for pagination

Credentials

This module requires Mercury type credentials with the following fields:

Field	Description
api_key	Mercury API Key (obtained in Settings > API)

Output

Specific recipient

{
  "success": true,
  "recipient": {
    "id": "rec_abc123",
    "name": "Proveedor XYZ",
    "emails": ["pagos@proveedor.com"],
    "paymentMethod": "ach",
    "electronicRoutingInfo": {
      "routingNumber": "123456789",
      "accountNumber": "9876543210",
      "bankName": "Chase Bank",
      "accountType": "checking"
    }
  },
  "recipient_id": "rec_abc123",
  "name": "Proveedor XYZ",
  "payment_method": "ach",
  "message": "Destinatario Proveedor XYZ obtenido"
}

All recipients

{
  "success": true,
  "recipients": [ ... ],
  "total": 25,
  "message": "25 destinatarios encontrados"
}

Payment Methods

• ach: ACH transfer (1-3 business days)
• domesticWire: US domestic wire (same day)
• internationalWire: International wire (2-5 days)
• check: Physical check

Usage Example

{
  "credentials_id": "mercury_cuenta",
  "recipient_id": "rec_abc123"
}

API Used

• API: Mercury API v1
• Endpoint: GET /api/v1/recipients
• Documentation: https://docs.mercury.com/reference

Notes

• Recipients include complete bank information
• Can be filtered by payment method
• Each recipient has a unique ID to use in transfers

Related Nodes

• MercuryCreateRecipient - Create new recipients
• MercuryCreateTransfer - Create transfers to recipients
• MercuryGetTransfers - View transfers made to recipients