API Overview
Crypto Deposits API
Crypto Payouts API
Cross-Currency API
Reserve Management API
curl --request GET \
--url https://api-sandbox.circle.com/v1/businessAccount/transfers/{id} \
--header 'Authorization: Bearer <token>'{
"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"
}
]
}
]
},
"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"
}
}Get a transfer
curl --request GET \
--url https://api-sandbox.circle.com/v1/businessAccount/transfers/{id} \
--header 'Authorization: Bearer <token>'{
"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"
}
]
}
]
},
"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"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Universally unique identifier (UUID v4) of a resource.
"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"
Response
Successfully retrieved a transfer.
A transfer of funds.
Show child attributes
Show child attributes
Unique system generated identifier for the entity.
"b8627ae8-732b-4d25-b947-1df8f4007a29"
A source of funds.
- Option 1
- Option 2
Show child attributes
Show child attributes
wallet The id of the wallet.
"12345"
Show child attributes
Show child attributes
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.
individual, business Full name of the identity.
1024"Satoshi Nakamoto"
Show child attributes
Show child attributes
Line one of the street address.
1024"100 Money Street"
City portion of the address.
1024"Boston"
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.
16"MA"
Postal / ZIP code of the address.
16"01234"
Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.
2"US"
Line two of the street address.
1024"Suite 1"
A destination of funds.
- Option 1
- Option 2
Show child attributes
Show child attributes
blockchain 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).
"0x8381470ED67C3802402dbbFa0058E8871F017A6F"
A blockchain that a given currency is available on.
ALGO, APTOS, ARB, AVAX, BASE, BTC, CELO, CODEX, ETH, HBAR, HYPEREVM, INK, LINEA, NEAR, NOBLE, OP, PLUME, PAH, POLY, SEI, SOL, SONIC, SUI, UNI, WORLDCHAIN, XDC, XLM, XRP, ZKS, ZKSYNC 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.
"123456789"
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.
pending, complete, failed An array of fees applied to a transaction. This is only available when there is at least one non-zero fee.
Show child attributes
Show child attributes
A hash that uniquely identifies the onchain transaction. This is only available where either source or destination are of type blockchain.
"0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63"
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
transfer_failed, transfer_denied, blockchain_error, insufficient_funds The create date of the transfer.
Was this page helpful?