Skip to main content
GET
/
v1
/
businessAccount
/
transfers
List all transfers
curl --request GET \
  --url https://api-sandbox.circle.com/v1/businessAccount/transfers \
  --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

​
Authorization
string
header
required

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

Query Parameters

​
walletId
string

Filters results to get only transfers to or from this Circle wallet.

​
sourceWalletId
string

Filters results to get only transfers from this Circle wallet.

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

​
destinationWalletId
string

Filters results to get only transfers to this Circle wallet.

​
from
string<date-time>

Queries items created since the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
to
string<date-time>

Queries items created before the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
pageBefore
string

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageAfter.

​
pageAfter
string

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageBefore.

​
pageSize
integer

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Required range: x >= 1
Example:

5

Response

Successfully retrieved a list of transfers.

​
data
object[]