Retrieve a transfer

curl --request GET \
  --url https://api.circle.com/v1/w3s/buidl/transfers/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "transfer": {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "amount": "1.0",
      "blockDate": "2023-01-01T12:04:05Z",
      "blockHash": "0x2eb19fd02850ff963efefbaa71dbcd4acb41a9c261c4f8961979db1b56d48704",
      "blockHeight": 123456,
      "blockchain": "MATIC-AMOY",
      "from": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "state": "COMPLETE",
      "to": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "tokenId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "transferType": "INBOUND_TRANSFER",
      "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
      "walletAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "errorReason": "FAILED_REORG",
      "nft": {
        "metadata": "ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1",
        "nftTokenId": "2"
      },
      "tokenAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "userOpHash": "0x54d3cccda6ffa503bc1e554937fe67818b6ca1a5a05c7e66ebfa32bf27520152",
      "createDate": "2023-01-01T12:04:05Z",
      "updateDate": "2023-01-01T12:04:05Z"
    }
  }
}

GET

w3s

buidl

transfers

{id}

Retrieve a transfer

curl --request GET \
  --url https://api.circle.com/v1/w3s/buidl/transfers/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "transfer": {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "amount": "1.0",
      "blockDate": "2023-01-01T12:04:05Z",
      "blockHash": "0x2eb19fd02850ff963efefbaa71dbcd4acb41a9c261c4f8961979db1b56d48704",
      "blockHeight": 123456,
      "blockchain": "MATIC-AMOY",
      "from": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "state": "COMPLETE",
      "to": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "tokenId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "transferType": "INBOUND_TRANSFER",
      "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
      "walletAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "errorReason": "FAILED_REORG",
      "nft": {
        "metadata": "ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1",
        "nftTokenId": "2"
      },
      "tokenAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
      "userOpHash": "0x54d3cccda6ffa503bc1e554937fe67818b6ca1a5a05c7e66ebfa32bf27520152",
      "createDate": "2023-01-01T12:04:05Z",
      "updateDate": "2023-01-01T12:04:05Z"
    }
  }
}

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

X-Request-Id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support. A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Path Parameters

string<uuid>

required

The universally unique identifier of the resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

Transfer retrieved successfully.

data

object

required

Show child attributes

data.transfer

Transfer · object

required

Show child attributes

data.transfer.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.transfer.amount

string

required

Amount of native token.

Example:

"1.0"

data.transfer.blockDate

string<date-time>

required

Date and time of block, in ISO-8601 UTC format.

Example:

"2023-01-01T12:04:05Z"

data.transfer.blockHash

string

required

Blockchain generated identifier of block.

Example:

"0x2eb19fd02850ff963efefbaa71dbcd4acb41a9c261c4f8961979db1b56d48704"

data.transfer.blockHeight

integer

required

Blockchain height of block.

Example:

123456

data.transfer.blockchain

enum<string>

required

Blockchain network of resource.

Available options:

ETH,

ETH-SEPOLIA,

MATIC,

MATIC-AMOY,

ARB,

ARB-SEPOLIA,

UNI,

UNI-SEPOLIA,

BASE,

BASE-SEPOLIA,

OP,

OP-SEPOLIA

Example:

"MATIC-AMOY"

data.transfer.from

string

required

Sender address of transfer.

Example:

"0x4b6c0b0078b63f881503e7fd3a9a1061065db242"

data.transfer.state

enum<string>

required

Transfer state.

Available options:

CONFIRMED,

COMPLETE,

FAILED

Example:

"COMPLETE"

data.transfer.to

string

required

Recipient address of transfer.

Example:

"0x4b6c0b0078b63f881503e7fd3a9a1061065db242"

data.transfer.tokenId

string<uuid>

required

Unique identifier of token.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.transfer.transferType

enum<string>

required

Available options:

INBOUND_TRANSFER,

OUTBOUND_TRANSFER

Example:

"INBOUND_TRANSFER"

data.transfer.txHash

string

required

Blockchain generated identifier of transaction.

Example:

"0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d"

data.transfer.walletAddress

string

required

Address of wallet.

Example:

"0x4b6c0b0078b63f881503e7fd3a9a1061065db242"

data.transfer.walletId

string<uuid>

required

Unique identifier of wallet.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.transfer.errorReason

enum<string>

Error reason of failed transfer.

Available options:

FAILED_REORG

Example:

"FAILED_REORG"

data.transfer.nft

NFT · object

Show child attributes

data.transfer.nft.metadata

string

NFT metadata.

Example:

"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1"

data.transfer.nft.nftTokenId

string

NFT token ID.

Example:

"2"

data.transfer.tokenAddress

string

Contract address of transferred token.

Example:

"0x4b6c0b0078b63f881503e7fd3a9a1061065db242"

data.transfer.userOpHash

string

Generated identifier of user operation.

Example:

"0x54d3cccda6ffa503bc1e554937fe67818b6ca1a5a05c7e66ebfa32bf27520152"

data.transfer.createDate

string<date-time>

Date and time the resource was created, in ISO-8601 UTC format.

Example:

"2023-01-01T12:04:05Z"

data.transfer.updateDate

string<date-time>

Date and time the resource was last updated, in ISO-8601 UTC format.

Example:

"2023-01-01T12:04:05Z"

List transfers

List user operations

API Overview

Configurations

Developer-Controlled

User-Controlled

Modular

Compliance Engine

Retrieve a transfer

Authorizations

Headers

Path Parameters

Response