Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clear-box.io/llms.txt

Use this file to discover all available pages before exploring further.

This guide implements the deposit step: the user moves fiat from their linked bank into their ClearBox wallet, where it arrives as USDC. It corresponds to the funding sequence your team works from, using the bank connection established in Link a bank with Quiltt.

Flow at a glance

1

User initiates a deposit

The user taps “Deposit $100 via bank transfer.” The frontend notifies the ClearBox backend.
2

Create a transfer authorization

ClearBox creates a bank-transfer authorization and receives a secure processor token.
3

Fund the wallet

ClearBox passes the processor token and the destination wallet address to the funding endpoint, triggering the ACH transaction.
4

Notify the user

The transaction is accepted as pending settlement; ClearBox shows a “funds arriving shortly” state.

1. Initiate the deposit

When the user starts a deposit, your backend begins the funding flow for the amount requested.
POST /v1/wallets/wlt_5c1d.../deposits
{
  "amount": "100.00",
  "currency": "USD",
  "source": "bank_connection",
  "bank_connection_id": "conn_3b9c..."
}

2. Create a bank-transfer authorization

ClearBox creates a transfer authorization from the linked bank connection and receives a secure, single-use processor token. The token authorizes the debit without exposing raw bank account numbers to downstream systems.
POST /v1/processor_tokens
{
  "bank_connection_id": "conn_3b9c...",
  "amount": "100.00",
  "currency": "USD"
}
{
  "processor_token": "ptok_7e2a...",
  "expires_at": "2026-05-28T16:10:00Z"
}

3. Fund the wallet

Pass the processor token together with the destination wallet address. This triggers the ACH transaction and credits the wallet once settled.
POST /v1/wallets/wlt_5c1d.../fund
{
  "processor_token": "ptok_7e2a...",
  "destination_wallet_address": "0xA1b2...C3d4"
}
A successful response indicates the ACH transaction was triggered and is pending settlement.
{
  "deposit_id": "dep_4a8c...",
  "status": "pending_settlement",
  "amount": "100.00",
  "currency": "USDC"
}

4. Notify the user

Show the user a processing state. The deposit clears asynchronously; subscribe to the deposit.settled webhook to update the balance when funds arrive.
ACH deposits settle on bank timelines, not instantly. The wallet’s spendable balance reflects settled funds. For instant spend at the point of sale, see how the mirror ledger authorizes against available balance.

Next: Issue a card

Derive a spendable virtual card from the funded wallet.

Reference

The endpoints above are ClearBox program endpoints. Your program may use a named bank-transfer processor; replace field names and the base URL with your actual values.