Mercury - Create Recipient
Description
Section titled “Description”This module allows creating a new recipient in Mercury to make ACH, domestic Wire, or international Wire transfers.
Configuration
Section titled “Configuration”| Field | Type | Required | Description |
|---|---|---|---|
| credentials_id | credential | Yes | Mercury credentials |
| name | string | Yes | Recipient name |
| string | No | Recipient email | |
| payment_method | select | No | Payment method (ach, domesticWire, etc.) |
| routing_number | string | No | Routing number (ACH/domestic Wire) |
| account_number | string | No | Account number |
| account_type | select | No | Account type (checking/savings) |
| bank_name | string | No | Bank name |
| swift_code | string | No | SWIFT code (international wire) |
| iban | string | No | IBAN (international wire) |
| address1 | string | No | Bank address |
| city | string | No | City |
| region | string | No | State/Region |
| postal_code | string | No | Postal code |
| country | string | No | Country (ISO code) |
Credentials
Section titled “Credentials”This module requires Mercury type credentials with the following fields:
| Field | Description |
|---|---|
api_key | Mercury API Key (obtained in Settings > API) |
Output
Section titled “Output”{ "success": true, "recipient": { ... }, "recipient_id": "rec_abc123", "name": "Proveedor XYZ", "payment_method": "ach", "message": "Destinatario Proveedor XYZ creado (rec_abc123)"}Examples by Payment Method
Section titled “Examples by Payment Method”ACH (US domestic)
Section titled “ACH (US domestic)”payment_method: "ach"routing_number: "021000021"account_number: "123456789"account_type: "checking"bank_name: "Chase Bank"International Wire
Section titled “International Wire”payment_method: "internationalWire"swift_code: "DEUTDEFF"iban: "DE89370400440532013000"bank_name: "Deutsche Bank"country: "DE"Usage Example
Section titled “Usage Example”{ "credentials_id": "mercury_cuenta", "name": "Proveedor XYZ", "email": "pagos@proveedor.com", "payment_method": "ach", "routing_number": "021000021", "account_number": "123456789", "account_type": "checking", "bank_name": "Chase Bank"}API Used
Section titled “API Used”- API: Mercury API v1
- Endpoint:
POST /api/v1/recipients - Documentation: https://docs.mercury.com/reference
- Recipients must be configured before making transfers
- For international wires, SWIFT is required and IBAN is optional
- Email is optional but recommended for notifications
Related Nodes
Section titled “Related Nodes”- MercuryCreateTransfer - Create transfers to the recipient
- MercuryGetRecipients - List existing recipients
- MercuryGetAccounts - Get source accounts