- The destination for an Offramp - stablecoins converted and paid out to this account.
- The source for an ACH-pull Onramp - HIFI debits this account to fund the onramp, instead of the user sending fiat in directly.
bankAddress.country, currency, and transferType - not every combination is supported, so an unsupported combination is rejected with a validation error.
For more details checkout Coverage and Account Information.
Counterparty requirements
The counterparty must beACTIVE, and have the following accepted fields set in addition to its own minimum, before you can add an external account for them:
For some corridors we may require additional information for the counterparty - for example, MXN and BRL, which require the counterparty’s
taxId. See Account Information for more details.ACTION_NOT_ALLOWED (422) - update the counterparty with the missing field and retry.
Add an external account
Registers a bank account for a counterparty. Requires anIdempotency-Key header. The example below is a US ACH account; other rails require different fields (e.g. iban + swiftCode for SEPA, pixKey for PIX).
Request
Sensitive fields (
accountNumber, iban, pixKey, etc.) are returned masked to the last 4 characters on every read after creation.Deactivate an external account
Revokes a previously-added bank account. A deactivated account can no longer be used as an offramp destination or onramp source, but its record and history are preserved. RequestRetrieve a counterparty’s external accounts
List a counterparty’s registered bank accounts, optionally filtered bystatus, transferType, or currency.
Request
Using an external account as an onramp source
Instead of a user sending fiat in directly, an onramp can be funded by pulling from a counterparty’s external account - passsource.externalAccountId instead of source.userId when creating the onramp. See Onramp for the full request shape.
ACH-pull funding only works with
transferType: "ACH" accounts, and the onramp’s source.currency must match the external account’s currency.ACH-pull is only available to a restricted set of customers - contact HIFI support for more information.
Getting Help
- 📧 Email: support@hifi.com
- 💬 Slack: Message us in our shared Slack channel
Related Resources
- Counterparty Overview - Counterparty resources
- Counter Party - Create and manage recipients/payers
- External Card - Cards for a counterparty