Fund your digital asset account with a wire deposit

Walk through a basic integration flow: confirm your account, link a bank account, get wire instructions, simulate a deposit, and verify the balance.

The Digital Asset Accounts API base URL is https://api-sandbox.circle.com for sandbox and https://api.circle.com for production. Set your API key in the Authorization header using the format Bearer YOUR_API_KEY. See Sandbox environment and Going to production for environment details.

Prerequisites

Before you begin, ensure that you’ve:

Obtained an API key for Digital Asset Accounts from your Circle representative.
Onboarded a business end user and recorded its clientEntityId and active accountId. See Onboard customers.
Run a device check for the end user and kept the deviceId it returned. The link-bank-account request in Step 2 requires the deviceId in riskSignals. See Collect device risk signals.
(Recommended) Configured a webhook subscription for tracking asynchronous events.
Checked whether Strong Customer Authentication (SCA) applies to your end users. Circle requires SCA for end users in the European Economic Area (EEA). See Implement SCA.
Set up mutual TLS (mTLS) for your entity’s API traffic before going to production, if your entity operates in the EEA under the Markets in Crypto-Assets (MiCA) regulation.

Step 1: Check your account balance

Confirm the account exists and check the starting balance:

curl --request GET \
  --url https://api-sandbox.circle.com/v1/accounts/ACCOUNT_ID \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace ACCOUNT_ID with your account ID and YOUR_API_KEY with your Bearer token.

{
  "data": {
    "balances": [
      {
        "amount": "0.00",
        "currency": "USD"
      }
    ]
  }
}

Step 2: Link a bank account

Link the end user’s bank account. Circle uses it to match incoming wires and as the destination for withdrawals.

curl --request POST \
  --url https://api-sandbox.circle.com/v1/banks/wires \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientEntityId": "CLIENT_ENTITY_ID",
    "idempotencyKey": "RANDOM_UUID",
    "accountNumber": "123456789",
    "routingNumber": "021000021",
    "billingDetails": {
      "name": "Acme Corp",
      "line1": "100 Money Street",
      "city": "Boston",
      "district": "MA",
      "postalCode": "01234",
      "country": "US"
    },
    "bankAddress": {
      "bankName": "Chase Bank",
      "city": "New York",
      "country": "US"
    },
    "riskSignals": {
      "ipAddress": "END_USER_IP",
      "sessionId": "SESSION_ID",
      "deviceId": "DEVICE_ID"
    }
  }'

Response

{
  "data": {
    "id": "b8a025e7-d5e5-4e5a-8e35-2f3a7d1c9b4a",
    "status": "complete",
    "description": "CHASE BANK ****6789",
    "trackingRef": "CIR3XXXYYY"
  }
}

The response is trimmed to the fields this quickstart uses. Save the id: it’s the WIRE_ID you use in the next step. For end users in the EEA, this request also needs SCA headers, and you can link an IBAN instead. See Wire deposits and withdrawals.

Step 3: Get wire instructions

Retrieve the wire instructions for the linked bank account. Wire instructions are the bank routing details your customer uses to send a wire transfer.

curl --request GET \
  --url 'https://api-sandbox.circle.com/v1/banks/wires/WIRE_ID/instructions?accountId=ACCOUNT_ID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

The response includes a trackingRef that must be included in the wire transfer:

{
  "data": {
    "trackingRef": "CIR3XXXYYY",
    "beneficiary": {
      "name": "Circle Internet Financial Inc",
      "address1": "99 High Street",
      "address2": "Boston, MA 02110"
    },
    "beneficiaryBank": {
      "name": "Silicon Valley Bank",
      "routingNumber": "121140399",
      "accountNumber": "1234567890",
      "currency": "USD",
      "country": "US"
    }
  }
}

Step 4: Simulate a wire deposit

In sandbox, simulate a wire deposit using the mock payments endpoint. In production, your customer sends a real wire transfer using the instructions from step 3.

curl --request POST \
  --url https://api-sandbox.circle.com/v1/mocks/payments/wire \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "trackingRef": "CIR3XXXYYY",
    "amount": {
      "amount": "10000.00",
      "currency": "USD"
    },
    "beneficiaryBank": {
      "accountNumber": "1234567890",
      "routingNumber": "121140399"
    }
  }'

The deposit starts in pending status (see Transaction states) and settles instantly in sandbox:

{
  "data": {
    "trackingRef": "CIR3XXXYYY",
    "amount": {
      "amount": "10000.00",
      "currency": "USD"
    },
    "status": "pending"
  }
}

Step 5: Verify the balance

After the deposit settles, check that the funds appear in your account:

curl --request GET \
  --url https://api-sandbox.circle.com/v1/accounts/ACCOUNT_ID \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

The balance now reflects the deposited amount:

{
  "data": {
    "balances": [
      {
        "amount": "10000.00",
        "currency": "USD"
      }
    ]
  }
}

You now have a funded account in sandbox. See Account structure to understand how programs, accounts, and subaccounts relate.

Mint

Match

StableFX

Digital Asset Accounts

End User Onboarding

Fund your digital asset account with a wire deposit

Prerequisites

Step 1: Check your account balance

Step 2: Link a bank account

Step 3: Get wire instructions

Step 4: Simulate a wire deposit

Step 5: Verify the balance

​Prerequisites

​Step 1: Check your account balance

​Step 2: Link a bank account

​Step 3: Get wire instructions

​Step 4: Simulate a wire deposit

​Step 5: Verify the balance

Prerequisites

Step 1: Check your account balance

Step 2: Link a bank account

Step 3: Get wire instructions

Step 4: Simulate a wire deposit

Step 5: Verify the balance