tools

Request bank transfer

Use this when the user asks to move money between two of their own bank or brokerage accounts linked in Banking. Request a bank transfer through Natural between two of the user's own accounts linked in BetterOff Banking. Call without account IDs or amount to list the accounts and the per-transfer cap. Saves a request for the user to review; never approves or starts the transfer. Return the review link and say it awaits the user's passkey approval.

post/v1/tools/betteroff_request_bank_transfer

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_request_bank_transfer
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: accounts:read, transfers:bank)
    • HTTP bearer

Request body

sourceAccountIdstring

Natural account ID to pull from, from this tool's account list.

destinationAccountIdstring

Natural account ID to send to, from this tool's account list.

amountUsdstring

US dollar amount as a decimal string, at most 2 decimals.

idempotencyKeystring

Required for outside agents. Reuse the same key when retrying the same request; use a new key for a new one.

Response

Tool result

OR

Changes

No recorded changes to this operation across all 1 revision of this API.