Skip to main content
POST
/
v1
/
businessAccount
/
transfers
Create a transfer
curl --request POST \
  --url https://api-sandbox.circle.com/v1/businessAccount/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "destination": {
    "type": "verified_blockchain",
    "addressId": "f1f36b85-cafe-484e-a46b-02340bfdb927"
  },
  "amount": {
    "amount": "3.14",
    "currency": "USD"
  },
  "customerExternalRef": "INV-2024-001234"
}
'
{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "source": {
      "type": "wallet",
      "id": "12345",
      "identities": [
        {
          "type": "individual",
          "name": "Satoshi Nakamoto",
          "addresses": [
            {
              "line1": "100 Money Street",
              "line2": "Suite 1",
              "city": "Boston",
              "district": "MA",
              "postalCode": "01234",
              "country": "US"
            }
          ]
        }
      ],
      "useMainWalletFunding": false
    },
    "destination": {
      "type": "blockchain",
      "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
      "addressTag": "123456789",
      "chain": "ALGO"
    },
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "fees": [
      {
        "amount": "10.00",
        "currency": "USD",
        "type": "network"
      }
    ],
    "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63",
    "status": "pending",
    "errorCode": "transfer_failed",
    "createDate": "2020-04-10T02:13:30.000Z",
    "customerExternalRef": "INV-2024-001234"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

​
destination
object
required
​
amount
object
required
​
source
object

The wallet to be used as the source of the transfer. If not provided, the transfer will come from the main wallet of the account.

You can get wallet IDs associated with your account using the Core API for Institutions.

​
customerExternalRef
string

An optional customer-supplied reference for reconciliation purposes. Only supported for cross-entity transfers.

Pattern: ^[A-Za-z0-9-]{1,21}$
Example:

"INV-2024-001234"

Response

201 - application/json

Successfully created a transfer.

​
data
object

A transfer of funds.