API Reference

Retrieve a transfer

gethttps://api.circle.com/v1/w3s/buidl/transfers/{id}

Reference
Playground

Retrieve an existing transfer.

Header parameters

X-Request-Id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Path parameters

uuid

Required

The universally unique identifier of the resource.

Response

200TransferResponse

Response Body

object

data

object

Required

Show 1 properties

transfer

object

Required

Show 20 properties

string

Required

System-generated unique identifier of the resource.

amount

string

Required

Amount of native token.

blockDate

string

Required

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

blockHash

string

Required

Blockchain generated identifier of block.

blockHeight

integer

Required

Blockchain height of block.

blockchain

string

Required

Blockchain network of resource.

Allowed valuesETHETH-SEPOLIAMATICMATIC-AMOYARBARB-SEPOLIAUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

errorReason

string

Error reason of failed transfer.

Allowed valuesFAILED_REORG

from

string

Required

Sender address of transfer.

nft

object

Show 2 properties

metadata

string

NFT metadata.

nftTokenId

string

NFT token ID.

state

string

Required

Transfer state.

Allowed valuesCONFIRMEDCOMPLETEFAILED

string

Required

Recipient address of transfer.

tokenAddress

string

Contract address of transferred token.

tokenId

string

Required

System-generated unique identifier of the resource.

transferType

string

Required

Allowed valuesINBOUND_TRANSFEROUTBOUND_TRANSFER

txHash

string

Required

Blockchain generated identifier of transaction.

userOpHash

string

Generated identifier of user operation.

walletAddress

string

Required

Address of wallet.

walletId

string

Required

System-generated unique identifier of the resource.

createDate

string

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

updateDate

string

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

400Error

401NotAuthorizedResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "transfer": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "amount": "1.0",
6      "blockDate": "2023-01-01T12:04:05Z",
7      "blockHash": "0x2eb19fd02850ff963efefbaa71dbcd4acb41a9c261c4f8961979db1b56d48704",
8      "blockHeight": 123456,
9      "blockchain": "MATIC-AMOY",
10      "errorReason": "FAILED_REORG",
11      "from": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
12      "nft": {
13        "metadata": "ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1",
14        "nftTokenId": "2"
15      },
16      "state": "COMPLETE",
17      "to": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
18      "tokenAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
19      "tokenId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
20      "transferType": "INBOUND_TRANSFER",
21      "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
22      "userOpHash": "0x54d3cccda6ffa503bc1e554937fe67818b6ca1a5a05c7e66ebfa32bf27520152",
23      "walletAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242",
24      "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
25      "createDate": "2023-01-01T12:04:05Z",
26      "updateDate": "2023-01-01T12:04:05Z"
27    }
28  }
29}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy