Transfer Instructions Schema

requires auth

Use this schema when working with transfer instructions for both deposits and withdrawals. These instructions define how funds or digital assets should be transferred to or from your account.

Schema

Field	Type	Description
name	string	A human-readable name for this set of instructions.
asset	string	Asset symbol (e.g., BTC, USDC, USD).
assetType	string	Type of asset, validated server-side. Examples: blockchain, fiat.
networkType	string	Blockchain network for crypto transfers (e.g., bitcoin, ethereum, tron). See Network Types.
address	string	Destination blockchain address for crypto transfers.
method	string	Fiat transfer network/method. See Fiat Methods.
bankName	string	Bank name (fiat).
bankAddress	string	Bank address (fiat).
bankRoutingNumber	string	Bank ABA routing number (numeric only).
bankSwiftNumber	string	Bank SWIFT/BIC number.
beneficiaryName	string	Beneficiary account holder name.
beneficiaryAddress	string	Beneficiary address.
beneficiaryAccountNumber	string	Beneficiary account number (alphanumeric).
ibanAccountNumber	string	IBAN account number (alphanumeric).
transitSortCode	string	Transit/Sort code (alphanumeric).
reference	string	Reference/memo to include with the transfer.
intermediaryBankName	string	Intermediary bank name (if applicable).
intermediaryBankAddress	string	Intermediary bank address.
intermediaryRoutingNumber	string	Intermediary ABA routing number (numeric only).
intermediarySwiftNumber	string	Intermediary SWIFT number.
specialInstructions	string	Free-form special instructions to assist processing.
instructions	object<string,string>	Key/value standardized and account-specific instruction details.

Conditional requirements (typical)

• For blockchain transfers (digital assets):

  • Typically include: asset, assetType = "blockchain", networkType, and address.

• For fiat transfers:

  • Typically include: assetType = "fiat", method (fiat network/method), and the appropriate bank/beneficiary fields (bankName, bankAddress, bankRoutingNumber or bankSwiftNumber, beneficiaryName, beneficiaryAccountNumber, etc.). Requirements vary by method/banking region.

Accepted values (examples)

• Asset types:

  • blockchain, fiat

• Blockchain networks (examples):

  • bitcoin, ethereum, tron, arbitrum, avalanche, bnb, optimism, solana, litecoin, etc.

• Fiat methods:

  • See Fiat Methods

The exact validation of these values is performed server-side and may evolve.

Examples

Blockchain example (BTC on Bitcoin)

{
  "name": "BTC Mainnet",
  "isAutomatic": true,
  "asset": "BTC",
  "assetType": "blockchain",
  "networkType": "bitcoin",
  "address": "bc1qexampleaddress..."
}

Fiat example (USD Wire)

{
  "name": "USD Wire",
  "isAutomatic": false,
  "asset": "USD",
  "assetType": "fiat",
  "method": "fedwire",
  "bankName": "First Example Bank",
  "bankAddress": "1 Bank Plaza, City, ST",
  "bankRoutingNumber": "123456789",
  "bankSwiftNumber": "CUESUS33",
  "beneficiaryName": "1Konto, Inc.",
  "beneficiaryAddress": "123 Business Ave, City, ST",
  "beneficiaryAccountNumber": "000123456789",
  "reference": "MyAccountId",
  "specialInstructions": "Include reference on wire memo",
  "instructions": { "memo": "MyAccountId", "purpose": "Deposit" }
}