Skip to Content
Apex Settlement

Balances and deposits

Read what you hold and where, fund your balance at the right Provider, and see a deposit arrive.

Every Payout is funded from your balance. Your balance is kept per asset and, within an asset, per Provider: the Provider that holds the money decides which routes can send it.

Read your balances

GET /v1/balances needs customer:read.

curl "$APEX_BASE_URL/v1/balances" \
  -H "Authorization: Bearer $APEX_API_KEY"
200 OK
[
  {
    "asset": "USDC",
    "available": "1500",
    "held": "0",
    "held_at": [
      { "provider": "zerohash", "available": "500", "held": "0" },
      { "provider": "bvnk", "available": "1000", "held": "0" }
    ]
  },
  {
    "asset": "USDT",
    "available": "9000",
    "held": "1000",
    "held_at": [
      { "provider": "zerohash", "available": "9000", "held": "1000" }
    ]
  }
]
FieldMeaning
assetThe asset.
availableWhat you can send now, across every Provider.
heldWhat is set aside for Payouts that are funded but not finished. It is released when a Payout completes or is refunded.
held_atThe same two figures for each Provider that holds part of the asset. provider is the key that GET /v1/deposit-instructions and quotes use.

available and held of an asset are the sums of its held_at entries. All amounts are decimal strings.

Why a balance is split by Provider

Each Provider keeps the money you deposit with it in your own account there. So:

  • A deposit is credited at the Provider it arrived at.
  • A Payout draws on one Provider only: the one where its route starts.
  • A refund goes back to the Provider the money was held at.

Money is never combined across Providers. With 500 USDC at one Provider and 1000 USDC at another, you can send up to 1000 USDC in one Payout, and only over a route that starts at the second Provider.

Get deposit instructions

GET /v1/deposit-instructions?asset= answers where to send an asset so that it is credited to your balance. You get one entry for each Provider that approved your account and takes deposits of that asset.

curl "$APEX_BASE_URL/v1/deposit-instructions?asset=EURC" \
  -H "Authorization: Bearer $APEX_API_KEY"
200 OK
[
  {
    "provider": "bvnk",
    "asset": "EURC",
    "network": "ETH",
    "address": "0x8b1e5f0c2a9d47e3b6c1f08a5d2e9b7c4a6f3d10"
  }
]

An entry is one of two shapes:

ShapeFieldsHow to pay in
On-chainnetwork, address, and memo when the network needs oneSend exactly asset on network to address. Include the memo, or the deposit cannot be credited to you.
Bank transferbank_details: the Provider's own field names and valuesMake a bank transfer with those details, as given.

Values are never masked: copy them as they are. An empty list means none of your Providers takes deposits of that asset. A malformed asset code answers asset_invalid (422).

Sandbox

In the sandbox, the deposit addresses are placeholders on no real network. Never send real funds to them; ask your account team to credit test funds to your sandbox balance instead. USDC and EURC can be deposited at one Provider, USDT and USDC at another. There are no bank deposits yet. See Environments.

How a deposit shows up

  1. You send the asset as the instruction says.
  2. The Provider confirms the deposit and that its source is verified. A deposit the Provider has not verified credits nothing until it is.
  3. The amount is added to available at that Provider, and the deposit.received webhook is sent:
deposit.received, the data field
{
  "asset": "EURC",
  "amount": "1000",
  "received_at": "2026-11-12T09:55:12Z"
}
  1. Payouts waiting in accepted for funds at that Provider are funded, oldest first.

See Webhooks for the envelope and its signature. A deposit made while your account is suspended is still credited, but funds no Payout until the account is active again.

Funds at another Provider

A quote answers funds_at_other_provider when you hold the send amount, but not at a Provider where any route to that Beneficiary starts. Tom holds 1000 USDC, all of it at a Provider where no route to his GBP Beneficiary starts, and quotes 1000 USDC:

POST /v1/quotes, 201 Created
{
  "quote_set_id": "5d2a8f0c-1e6b-4b7a-9c3d-8f4e2a1b6c90",
  "quotes": [],
  "unavailable_reason": "funds_at_other_provider",
  "deposit_at": ["bvnk"],
  "server_time": "2026-11-12T10:00:00Z"
}

Read deposit_at

It names the Providers where a deposit of the send asset would open a route. It is never empty with this reason.

Get the instructions

Call GET /v1/deposit-instructions?asset=USDC and keep the entry whose provider is in deposit_at.

Deposit and wait

Send the amount there, and wait for deposit.received or for held_at in GET /v1/balances to show it.

Quote again

POST /v1/quotes with the same body now answers quotes.

There is no call that moves your money from one Provider to another.

Withdraw to your own bank account

A withdrawal is an ordinary Payout to one of your own_account Beneficiaries. Register the account, wait until compliance verifies it, then quote and pay it like any other Beneficiary. A balance in a local currency, such as PKR credited to you by other Customers, is withdrawn to your own account in the same country and currency. See Beneficiaries and Send a payout.

Next steps

On this page