External Accounts

An external account is any destination outside Blacksheep that you can withdraw to. There are two kinds:

Bank accounts

For fiat withdrawals. A bank external account holds the account holder's name (account_name), the account number, and rail-specific routing details (e.g. BSB for AUD, routing number for USD, bank code, CLABE, PIX key).

Use account.external.bank.getAll to retrieve the bank external accounts on the account.

Wallets

For crypto withdrawals. A wallet external account holds an on-chain address and its address family (e.g. evm).

Use account.external.web3.getAll to retrieve the wallet external accounts on the account.

Using external accounts

To withdraw, pass the external_account_id to transaction.submitWithdraw. Blacksheep validates that the external account belongs to your account and matches the currency_out of the withdrawal (a fiat external account for fiat currencies, a crypto wallet for crypto currencies).

Recipients (third-party destinations)

External accounts can belong to a third party — for example, a customer's bank account that you're paying out to. These are sometimes called recipients. See Recipients.