Skip to navigation

Overview

The bank accounts and wallets your funds move through.
← Switch to the Production API

This is the sandbox. It runs on testnets only. Never send real money or real tokens to an address or bank account the sandbox returns.

The sandbox is subject to the Beta Features section of our Terms of Use.

An account is a place value enters or leaves: a fiat bank account or a blockchain wallet your organization owns. Routes reference an account as their destination via to.accountId.

GET /v0/accounts returns both kinds in one paginated list, distinguished by a kind discriminator:

  • kind: "bank": a bank account record, with bankName, accountNumber, routingNumber, beneficiary, and currency. The sandbox stores it for fiat routes but never sends money to it or takes money from it.
  • kind: "wallet": a blockchain address. In the sandbox, addressFormat is always ethereum and networks lists avalanche-fuji, ethereum-sepolia, or both.

Approvals in the sandbox

The sandbox approves everything automatically. Nothing is screened, and nothing is rejected.

  • Wallets. Registering a wallet starts a mint entitlement on each network, plus instant_settlement on networks that support it. mint comes back conditionally_approved, which is usable right away. Every entitlement becomes approved within about a minute.
  • Requested entitlements. An entitlement requested with requestEntitlement starts pending_approval and is approved within about a minute.
  • Bank accounts. A bank account is marked verified within about a minute. Bank accounts have no status field, so the API does not show this.

In production, pending_approval waits on Agora review, and entitlements can be rejected. Make sure your integration handles both, even though the sandbox never triggers them.

Managing accounts

  • GET /v0/accounts/{accountId}: retrieve one account by id.
  • POST /v0/accounts: register a wallet with the networks to register it on, or a bank account.
  • PUT /v0/accounts/{accountId}: rename an account (setName), register a wallet on another network (addNetwork), or request an entitlement (requestEntitlement).

GET /v0/accounts also takes kind, network, and createdAt range filters. See Filtering list endpoints.