API Reference

Get a transaction

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

Reference
Playground

Retrieves info for a single transaction using it's unique identifier.

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.

Query parameters

txType

string

Filter by on the transaction type.

Response

200TransactionResponse

Response Body

object

data

object

Required

Show 1 properties

transaction

object

Show 31 properties

string

Required

System-generated unique identifier of the resource.

abiFunctionSignature

string

The contract ABI function signature or callData field is required for interacting with the smart contract. The ABI function signature cannot be used simultaneously with callData. e.g. burn(uint256)

abiParameters

array of strings, integers, booleans, arrays

The contract ABI function signature parameters for executing the contract interaction. Supported parameter types include string, integer, boolean, and array. These parameters should be used exclusively with the abiFunctionSignature and cannot be used with callData.

option 1: string

option 2: integer

option 3: boolean

option 4: array

amounts

array of strings

Transfer amounts in decimal number format, at least one element is required for transfer. For ERC721 token transfer, the amounts field is required to be ["1"] (array with "1" as the only element).

amountInUSD

string

Transaction amount in USD decimal format.

blockHash

string

Identifier for the block that includes the transaction.

blockHeight

integer

Block height of the transaction, representing the number of blockchain confirmations.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIANEARNEAR-TESTNETEVMEVM-TESTNETUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA

contractAddress

string

The blockchain address of the contract to be executed.

createDate

string

Required

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

custodyType

string

Describes who controls the digital assets in a wallet: either the end-user or the developer.

Allowed valuesDEVELOPERENDUSER

destinationAddress

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

errorReason

string

Description of the error. Only present for transactions in FAILED state.

errorDetails

string

Additional detail associated with the corresponding transaction's error reason

estimatedFee

object

The estimated fee for the transaction. For Get Transactions API, this will only be returned if transaction type is used in the request query parameters

Show 6 properties

gasLimit

string

The maximum units of gas to use for the transaction. Required if feeLevel is not provided. Estimates for this limit can be obtained through the POST /transactions/transfer/estimateFee API. GasLimit override (only supported for EOA wallets): Using gasLimit together with feeLevel, the provided gasLimit is required to be greater or equal to feeLevel estimation and will override the estimation's gasLimit.

gasPrice

string

For blockchains without EIP-1559 support, the maximum price of gas, in gwei, to use per each unit of gas (see gasLimit). Requires gasLimit. Cannot be used with feeLevel, priorityFee, or maxFee. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

maxFee

string

For blockchains with EIP-1559 support, the maximum price per unit of gas (see gasLimit), in gwei. Requires priorityFee, and gasLimit to be present. Cannot be used with feeLevel or gasPrice. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

priorityFee

string

For blockchains with EIP-1559 support, the “tip”, in gwei, to add to the base fee as an incentive for validators. Please note that the maxFee and gasLimit parameters are required alongside the priorityFee. The feeLevel and gasPrice parameters cannot be used with the priorityFee. Estimations for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

baseFee

string

For blockchains with EIP-1559 support, the estimated base fee represents the minimum fee required for a transaction to be included in a block on the blockchain. It is measured in gwei and compensates for the computational resources validators consume to process the transaction. The base fee is supplemented by a separate "tip" called the priority fee, which acts as an extra incentive for validators to prioritize the transaction. The priority fee is added to the base fee to calculate the final transaction fee.

networkFee

string

The estimated network fee is the maximum amount of cryptocurrency (such as ETH, ARB, or SOL) that you will pay for your transaction. This fee depends on the parameters you set, including Gas Limit, Priority Fee, and Max Fee. It compensates for the computational resources that validators consume to process the transaction. It is measured in native token such as ETH, SOL. For blockchains with L1 data fees such as OP/BASE, the network fee is a combination of the Execution Gas Fee and the L1 Data Fee. Each blockchain might use different formula for network fee. Refer to each specific blockchain's documentation to understand how networkFee is calculated.

feeLevel

string

Defines the blockchain fee level which will be paid for the transaction e.g. LOW, MEDIUM, HIGH. For Get Transactions API, this will only be returned if transaction type is used in the request query parameters

Allowed valuesLOWMEDIUMHIGH

firstConfirmDate

string

Date the transaction was first confirmed in a block. ISO-8601 UTC date/time.

networkFee

string

Gas fee, in native token, paid to the network for the transaction.

networkFeeInUSD

string

Gas fee, in USD, paid to the network for the transaction.

nfts

array of strings

List of Nfts, in JSON string format, associated with the transaction.

operation

string

Operation type of the transaction.

Allowed valuesTRANSFERCONTRACT_EXECUTIONCONTRACT_DEPLOYMENT

refId

string

Optional reference or description used to identify the transaction.

sourceAddress

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

state

string

Required

Current state of the transaction.

Allowed valuesCANCELLEDCONFIRMEDCOMPLETEDENIEDFAILEDINITIATEDPENDING_RISK_SCREENINGQUEUEDSENT

tokenId

string

System-generated unique identifier of the resource.

transactionType

string

Required

Allowed valuesINBOUNDOUTBOUND

txHash

string

Blockchain generated identifier of the transaction.

updateDate

string

Required

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

userId

string

Unique system generated identifier for the user.

walletId

string

System-generated unique identifier of the resource.

transactionScreeningEvaluation

object

Show 4 properties

ruleName

string

Name of the matched rule found in screening.

actions

array of strings

Actions to take for the decision.

Allowed valuesAPPROVEREVIEWFREEZE_WALLETDENY

screeningDate

string

Required

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

reasons

array of objects

Risk signals found include source, value, and type of the signal. It also contains risk score and risk category.

Show 5 properties

source

string

Required

Source of the risk signal.

Allowed valuesADDRESSBLOCKCHAINASSET

sourceValue

string

Required

Value of the source. For example, if source is “ADDRESS”. The source value would be an blockchain address.

riskScore

string

Required

Risk score of the signal.

Allowed valuesUNKNOWNLOWMEDIUMHIGHSEVEREBLOCKLIST

riskCategories

array of strings

Required

List of risk categories for the signal.

Allowed valuesSANCTIONSCSAMILLICIT_BEHAVIORGAMBLINGTERRORIST_FINANCINGUNSUPPORTEDFROZENOTHERHIGH_RISK_INDUSTRYPEPTRUSTEDHACKINGHUMAN_TRAFFICKINGSPECIAL_MEASURES

type

string

Required

Type of the signal.

Allowed valuesOWNERSHIPCOUNTERPARTYINDIRECT

400Error

401NotAuthorizedResponse

404NotFoundResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "transaction": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "abiFunctionSignature": "burn(uint256)",
6      "abiParameters": [
7        "100",
8        "1"
9      ],
10      "amounts": [
11        "6.62607015"
12      ],
13      "amountInUSD": "",
14      "blockHash": "",
15      "blockHeight": 0,
16      "blockchain": "MATIC-AMOY",
17      "contractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
18      "createDate": "2023-01-01T12:04:05Z",
19      "custodyType": "DEVELOPER",
20      "destinationAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
21      "errorReason": "",
22      "errorDetails": "",
23      "estimatedFee": {
24        "gasLimit": "21000",
25        "gasPrice": "",
26        "maxFee": "5.935224468",
27        "priorityFee": "1.022783914",
28        "baseFee": "1.022783914",
29        "networkFee": "0.0001246397138"
30      },
31      "feeLevel": "MEDIUM",
32      "firstConfirmDate": "2021-05-18T00:00:00Z",
33      "networkFee": "",
34      "networkFeeInUSD": "",
35      "nfts": [
36        "[{\"ntfTokenId\":\"12321\"",
37        "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1\"}",
38        "{\"ntfTokenId\":\"12322\"",
39        "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/2\"}]"
40      ],
41      "operation": "TRANSFER",
42      "refId": "grouptransaction123",
43      "sourceAddress": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
44      "state": "CANCELLED",
45      "tokenId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
46      "transactionType": "INBOUND",
47      "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
48      "updateDate": "2023-01-01T12:04:05Z",
49      "userId": "ext_user_id_1",
50      "walletId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
51      "transactionScreeningEvaluation": {
52        "ruleName": "Low Gambling Risk (Owner)",
53        "actions": [
54          "REVIEW"
55        ],
56        "screeningDate": "2023-01-01T12:04:05Z",
57        "reasons": [
58          {
59            "source": "ADDRESS",
60            "sourceValue": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
61            "riskScore": "LOW",
62            "riskCategories": [
63              "GAMBLING"
64            ],
65            "type": "OWNERSHIP"
66          }
67        ]
68      }
69    }
70  }
71}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy