Skip to content

Mercury - Create Recipient

This module allows creating a new recipient in Mercury to make ACH, domestic Wire, or international Wire transfers.

FieldTypeRequiredDescription
credentials_idcredentialYesMercury credentials
namestringYesRecipient name
emailstringNoRecipient email
payment_methodselectNoPayment method (ach, domesticWire, etc.)
routing_numberstringNoRouting number (ACH/domestic Wire)
account_numberstringNoAccount number
account_typeselectNoAccount type (checking/savings)
bank_namestringNoBank name
swift_codestringNoSWIFT code (international wire)
ibanstringNoIBAN (international wire)
address1stringNoBank address
citystringNoCity
regionstringNoState/Region
postal_codestringNoPostal code
countrystringNoCountry (ISO code)

This module requires Mercury type credentials with the following fields:

FieldDescription
api_keyMercury API Key (obtained in Settings > API)
{
"success": true,
"recipient": { ... },
"recipient_id": "rec_abc123",
"name": "Proveedor XYZ",
"payment_method": "ach",
"message": "Destinatario Proveedor XYZ creado (rec_abc123)"
}
payment_method: "ach"
routing_number: "021000021"
account_number: "123456789"
account_type: "checking"
bank_name: "Chase Bank"
payment_method: "internationalWire"
swift_code: "DEUTDEFF"
iban: "DE89370400440532013000"
bank_name: "Deutsche Bank"
country: "DE"
{
"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"
}
  • Recipients must be configured before making transfers
  • For international wires, SWIFT is required and IBAN is optional
  • Email is optional but recommended for notifications
  • MercuryCreateTransfer - Create transfers to the recipient
  • MercuryGetRecipients - List existing recipients
  • MercuryGetAccounts - Get source accounts