Skip to content

Mercury - Get Transfers

This module allows getting the outgoing transfers from a Mercury account, with filters by status, date, and pagination. It can query a specific transfer or list all.

FieldTypeRequiredDescription
credentials_idcredentialYesMercury credentials
account_idstringYesAccount ID
transfer_idstringNoSpecific transfer ID
statusselectNoFilter by status
start_datestringNoStart date (YYYY-MM-DD)
end_datestringNoEnd date (YYYY-MM-DD)
limitnumberNoResults limit (default: 50)
offsetnumberNoOffset for pagination

This module requires Mercury type credentials with the following fields:

FieldDescription
api_keyMercury API Key (obtained in Settings > API)
{
"success": true,
"transfer": { ... },
"transfer_id": "txn_abc123",
"status": "sent",
"amount": 5000.00,
"payment_method": "ach",
"created_at": "2024-01-15T10:30:00Z",
"message": "Transferencia txn_abc123 obtenida (sent)"
}
{
"success": true,
"transfers": [ ... ],
"total": 45,
"account_id": "abc123",
"message": "45 transferencias encontradas"
}
StatusDescription
pendingPending to send
sentSent to bank
cancelledCanceled
failedFailed
{
"credentials_id": "mercury_cuenta",
"account_id": "abc123",
"status": "sent",
"start_date": "2024-01-01",
"end_date": "2024-01-31"
}
  • Only outgoing transfers (externalTransfer) are shown
  • ACH transfers may take up to 3 days to be reflected
  • Domestic wires are processed the same day
  • MercuryCreateTransfer - Create new transfers
  • MercuryGetRecipients - View transfer recipients
  • MercuryGetAccounts - Get account ID to query
  • MercuryGetTransactions - View all transactions including transfers