get_transaction

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Health

Webhook Subscriptions

Monitor Tokens

Developer Account

Faucet

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

get_transactionPython,latest

Go to PyPI

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

Parameters

string

Required

Transaction id

x_user_token

string

Required

Unique system generated JWT session token for specific user.

x_request_id

string

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

tx_type

string

Filter by on the transaction type.

Allowed valuesINBOUNDOUTBOUND

Responses

200TransactionResponse

Response Body

object

data

object

Required

Show 1 properties

transaction

object

Show 31 properties

string

Required

System-generated unique identifier of the resource.

abi_function_signature

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)

abi_parameters

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).

amount_in_usd

string

Transaction amount in USD decimal format.

block_hash

string

Identifier for the block that includes the transaction.

block_height

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-SEPOLIAAPTOSAPTOS-TESTNET

contract_address

string

The blockchain address of the contract to be executed.

create_date

string

Required

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

custody_type

string

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

Allowed valuesDEVELOPERENDUSER

destination_address

string

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

error_reason

string

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

error_details

string

Additional detail associated with the corresponding transaction's error reason

estimated_fee

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 8 properties

gas_limit

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.

gas_price

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.

max_fee

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.

priority_fee

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.

base_fee

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.

network_fee

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.

network_fee_raw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

l_1_fee

string

This is the L1 rollup fee incurred for Layer 2 blockchain transactions. The value is returned in native currency, e.g. ETH.

fee_level

string

A dynamic blockchain fee level setting (LOW, MEDIUM, or HIGH) that will be used to pay gas for the transaction. Calculated based on network traffic, supply of validators, and demand for transaction verification. Cannot be used with gasPrice, priorityFee, or maxFee. Estimates for each fee level can be obtained through the POST /transactions/transfer/estimateFee API.

Allowed valuesLOWMEDIUMHIGH

first_confirm_date

string

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

network_fee

string

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

network_fee_in_usd

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

ref_id

string

Optional reference or description used to identify the transaction.

source_address

string

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

state

string

Required

Current state of the transaction.

Allowed valuesCANCELLEDCONFIRMEDCOMPLETEDENIEDFAILEDINITIATEDCLEAREDQUEUEDSENTSTUCK

token_id

string

System-generated unique identifier of the resource.

transaction_type

string

Required

Allowed valuesINBOUNDOUTBOUND

tx_hash

string

Blockchain generated identifier of the transaction.

update_date

string

Required

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

user_id

string

Unique system generated identifier for the user.

wallet_id

string

System-generated unique identifier of the resource.

transaction_screening_evaluation

object

Show 4 properties

rule_name

string

Name of the matched rule found in screening.

actions

array of strings

Actions to take for the decision.

Allowed valuesAPPROVEREVIEWFREEZE_WALLETDENY

screening_date

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

source_value

string

Required

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

risk_score

string

Required

Risk score of the signal.

Allowed valuesUNKNOWNLOWMEDIUMHIGHSEVEREBLOCKLIST

risk_categories

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

Example

1from circle.web3 import user_controlled_wallets
2from circle.web3 import utils
3
4client = utils.init_user_controlled_wallets_client(api_key=key)
5
6api_instance = user_controlled_wallets.TransactionsApi(client)
7
8response = api_instance.get_transaction(x_user_token=user_token, id="c7064cb0-19ba-57c3-a4d2-92cf71ede662")
9print(response.json())
10

ResponseChoose an example

1{
2  "data": {
3    "transaction": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "abi_function_signature": "burn(uint256)",
6      "abi_parameters": [
7        "100",
8        "1"
9      ],
10      "amounts": [
11        "6.62607015"
12      ],
13      "amount_in_usd": "",
14      "block_hash": "",
15      "block_height": 0,
16      "blockchain": "MATIC-AMOY",
17      "contract_address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
18      "create_date": "2023-01-01T12:04:05Z",
19      "custody_type": "DEVELOPER",
20      "destination_address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
21      "error_reason": "",
22      "error_details": "",
23      "estimated_fee": {
24        "gas_limit": "21000",
25        "gas_price": "",
26        "max_fee": "5.935224468",
27        "priority_fee": "1.022783914",
28        "base_fee": "1.022783914",
29        "network_fee": "0.0001246397138",
30        "network_fee_raw": "0.0001246397138",
31        "l_1_fee": "0.000000000000140021"
32      },
33      "fee_level": "MEDIUM",
34      "first_confirm_date": "2021-05-18T00:00:00Z",
35      "network_fee": "",
36      "network_fee_in_usd": "",
37      "nfts": [
38        "[{\"ntfTokenId\":\"12321\"",
39        "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/1\"}",
40        "{\"ntfTokenId\":\"12322\"",
41        "\"metadata\":\"ipfs://QmZcH4YvBVVRJtdn4RdbaqgspFU8gH6P9vomDpBVpAL3u4/2\"}]"
42      ],
43      "operation": "TRANSFER",
44      "ref_id": "grouptransaction123",
45      "source_address": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
46      "state": "CANCELLED",
47      "token_id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
48      "transaction_type": "INBOUND",
49      "tx_hash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
50      "update_date": "2023-01-01T12:04:05Z",
51      "user_id": "ext_user_id_1",
52      "wallet_id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
53      "transaction_screening_evaluation": {
54        "rule_name": "Low Gambling Risk (Owner)",
55        "actions": [
56          "REVIEW"
57        ],
58        "screening_date": "2023-01-01T12:04:05Z",
59        "reasons": [
60          {
61            "source": "ADDRESS",
62            "source_value": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
63            "risk_score": "LOW",
64            "risk_categories": [
65              "GAMBLING"
66            ],
67            "type": "OWNERSHIP"
68          }
69        ]
70      }
71    }
72  }
73}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy