API Reference

Wallets

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Create a transfer

posthttps://api-sandbox.circle.com/v1/businessAccount/transfers

Reference
Playground

A transfer can be made from an existing business account to a blockchain location.

Body parameters

amount

object

Required

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code for the amount.

Allowed valuesUSDEURBTCETH

destination

object

Required

Show 2 properties

type

string

Required

Allowed valuesverified_blockchain

addressId

string

Required

The ID of the verified blockchain recipient address.

idempotencyKey

string

Required

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

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.

Show 2 properties

string

Required

Unique system-generated identifier for the wallet of the institutional entity.

type

string

Required

Allowed valueswallet

Response

201CreateBusinessTransferResponse

Response Body

object

data

object

A transfer of funds.

Show 9 properties

string

Required

Unique system generated identifier for the entity.

source

object

Required

A source of funds.

option 1: object

Show 3 properties

type

string

Required

Allowed valueswallet

string

Required

The id of the wallet.

identities

array of objects

Show 3 properties

type

string

Required

The type of identity for the originator.

individual - A uniquely distinguishable individual.
business - Any entity other than a natural person that can establish a permanent customer relationship with an affected entity or otherwise own property. This can include companies, foundations, anstalt, partnerships, associations and other relevantly similar entities.

Allowed valuesindividualbusiness

name

string

Required

Full name of the identity.

addresses

array of objects

Required

Show 6 properties

line1

string

Required

Line one of the street address.

line2

string

Line two of the street address.

city

string

Required

City portion of the address.

district

string

Required

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCode

string

Required

Postal / ZIP code of the address.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

option 2: object

Show 3 properties

type

string

Required

Allowed valuesblockchain

chain

string

Required

A blockchain that a given currency is available on.

Allowed valuesALGOAPTOSARBAVAXBASEBTCCELOCODEXETHHBARHYPEREVMINKLINEANEARNOBLEOPPLUMEPAHPOLYSEISOLSONICSUIUNIWORLDCHAINXDCXLMXRPZKSZKSYNC

identities

array of objects

Show 3 properties

type

string

Required

The type of identity for the originator.

individual - A uniquely distinguishable individual.
business - Any entity other than a natural person that can establish a permanent customer relationship with an affected entity or otherwise own property. This can include companies, foundations, anstalt, partnerships, associations and other relevantly similar entities.

Allowed valuesindividualbusiness

name

string

Required

Full name of the identity.

addresses

array of objects

Required

Show 6 properties

line1

string

Required

Line one of the street address.

line2

string

Line two of the street address.

city

string

Required

City portion of the address.

district

string

Required

State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.

postalCode

string

Required

Postal / ZIP code of the address.

country

string

Required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

destination

object

Required

A destination of funds.

option 1: object

Show 4 properties

type

string

Required

Allowed valuesblockchain

address

string

Required

An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address.
Important: For Ripple (XRP) addresses, only the classic address format is supported (for example, rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY).
The x-address format is NOT supported currently (for example, XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV).

addressTag

string

The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.

chain

string

Required

A blockchain that a given currency is available on.

Allowed valuesALGOAPTOSARBAVAXBASEBTCCELOCODEXETHHBARHYPEREVMINKLINEANEARNOBLEOPPLUMEPAHPOLYSEISOLSONICSUIUNIWORLDCHAINXDCXLMXRPZKSZKSYNC

option 2: object

Show 4 properties

type

string

Required

Allowed valueswallet

string

Required

The id of the wallet.

address

string

An alphanumeric string which indicates the wallet address used to receive the transfer. Will only be set when the transfer source is a blockchain address.

addressTag

string

The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.

amount

object

Required

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code for the amount.

Allowed valuesUSDEURBTCETH

fees

array of objects

An array of fees applied to a transaction. This is only available when there is at least one non-zero fee.

Show 3 properties

amount

string

Required

Magnitude of the fee amount, in units of the currency, with a ..

currency

string

Required

Currency code for the amount.

Allowed valuesUSD

type

string

Required

Category of the fee.

Allowed valuesnetwork

transactionHash

string

A hash that uniquely identifies the onchain transaction. This is only available where either source or destination are of type blockchain.

status

string

Required

Status of the transfer. Status pending indicates that the transfer is in the process of running; complete indicates it finished successfully; failed indicates it failed. Circle Mint Singapore customers may have transfers in the pending status if the recipient addresses are not verified.

Allowed valuespendingcompletefailed

errorCode

string

Indicates the failure reason of a transfer. Only present for transfers in a failed state. Possible values are insufficient_funds, blockchain_error and transfer_denied and transfer_failed

Allowed valuestransfer_failedtransfer_deniedblockchain_errorinsufficient_funds

createDate

string

The create date of the transfer.

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "source": {
5      "type": "wallet",
6      "id": "12345",
7      "identities": [
8        {
9          "type": "individual",
10          "name": "Satoshi Nakamoto",
11          "addresses": [
12            {
13              "line1": "100 Money Street",
14              "line2": "Suite 1",
15              "city": "Boston",
16              "district": "MA",
17              "postalCode": "01234",
18              "country": "US"
19            }
20          ]
21        }
22      ]
23    },
24    "destination": {
25      "type": "blockchain",
26      "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
27      "addressTag": "123456789",
28      "chain": "ALGO"
29    },
30    "amount": {
31      "amount": "3.14",
32      "currency": "USD"
33    },
34    "fees": [
35      {
36        "amount": "10.00",
37        "currency": "USD",
38        "type": "network"
39      }
40    ],
41    "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63",
42    "status": "pending",
43    "errorCode": "transfer_failed",
44    "createDate": ""
45  }
46}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy