Get Transaction by Transaction ID

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java
.NET
Go
Python
CLI
TS/JS

TransactionsService transactionsService = PrimeServiceFactory.createTransactionsService(client);

GetTransactionByTransactionIdRequest request = new GetTransactionByTransactionIdRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .transactionId("TRANSACTION_ID_HERE")
    .build();

GetTransactionByTransactionIdResponse response = transactionsService.getTransactionByTransactionId(request);

For more information, please visit the Prime Java SDK.

Path Parameters

portfolio_id

string

required

The portfolio ID

transaction_id

string

required

The transaction ID

Response

200 - application/json

A successful response.

transaction

object

Show child attributes

transaction.id

string

The ID of the transaction

Example:

"BTC-USD"

transaction.wallet_id

string

The wallet ID of the transaction

Example:

"cde8dd34-b6cf-4c2c-82bc-5f86adacc868"

transaction.portfolio_id

string

The portfolio ID of the transaction

Example:

"0a66a8c0-24ea-4f18-b14f-8c9cf7c1ba40"

transaction.type

enum<string>

TRANSACTION_TYPE_UNKNOWN: An unknown transaction type
DEPOSIT: A fiat or crypto deposit
WITHDRAWAL: A fiat or crypto withdrawal
INTERNAL_DEPOSIT: An internal fiat or crypto deposit
INTERNAL_WITHDRAWAL: An internal fiat or crypto withdrawal
SWEEP_DEPOSIT: Internal automated deposit to a cold address from a restored address
SWEEP_WITHDRAWAL: Internal automated withdrawal from a restored address to a cold address
PROXY_DEPOSIT: On-chain deposit of funds into proxy contract from cold address
PROXY_WITHDRAWAL: On-chain withdrawal of funds from proxy contract to cold address
BILLING_WITHDRAWAL: Coinbase Prime automated invoice settlement payment
REWARD: Reward payment to an associated address for a staked asset
COINBASE_REFUND: Coinbase Prime refund for the leftover amount for a CPFP (child pays for parent) transaction
TRANSACTION_TYPE_OTHER: An OTHER type of transaction
WITHDRAWAL_ADJUSTMENT: A manual adjustment withdrawal transaction
DEPOSIT_ADJUSTMENT: A manual adjustment deposit transaction
KEY_REGISTRATION: An on-chain registration for an address
DELEGATION: An on-chain delegation transaction
UNDELEGATION: An on-chain undelegation transaction
RESTAKE: On-chain restaking transaction
COMPLETE_UNBONDING: On-chain unbonding event transaction
WITHDRAW_UNBONDED: On-chain event indicating unbonding period is over
STAKE_ACCOUNT_CREATE: On-chain transaction to begin staking from an address
CHANGE_VALIDATOR: On-chain transaction alter validator
STAKE: On-chain transaction to begin staking in Cryptocurrency network
UNSTAKE: On-chain transaction to stop staking in Cryptocurrency network
REMOVE_AUTHORIZED_PARTY: On-chain transaction to remove a party from a multi-signature wallet
STAKE_AUTHORIZE_WITH_SEED: On-chain transaction to begin staking from a seed account
SLASH: On-chain transaction indicating a slash event has occurred
COINBASE_DEPOSIT: On-chain transaction deposit for the purpose of transaction operations
CONVERSION: Internal conversion between two assets
CLAIM_REWARDS: On-chain transaction to claim rewards from Vote Account
VOTE_AUTHORIZE: On-chain transaction to transfer the reward claiming permission to other pubkey
WEB3_TRANSACTION: On-chain transaction initiated with Prime Onchain Wallet Deprecated: Use ONCHAIN_TRANSACTION instead
ONCHAIN_TRANSACTION: On-chain transaction initiated with Prime Onchain Wallet
PORTFOLIO_STAKE: Portfolio-level staking operation
PORTFOLIO_UNSTAKE: Portfolio-level unstaking operation

Available options:

DEPOSIT,

WITHDRAWAL,

INTERNAL_DEPOSIT,

INTERNAL_WITHDRAWAL,

SWEEP_DEPOSIT,

SWEEP_WITHDRAWAL,

PROXY_DEPOSIT,

PROXY_WITHDRAWAL,

BILLING_WITHDRAWAL,

REWARD,

COINBASE_REFUND,

TRANSACTION_TYPE_OTHER,

WITHDRAWAL_ADJUSTMENT,

DEPOSIT_ADJUSTMENT,

KEY_REGISTRATION,

DELEGATION,

UNDELEGATION,

RESTAKE,

COMPLETE_UNBONDING,

WITHDRAW_UNBONDED,

STAKE_ACCOUNT_CREATE,

CHANGE_VALIDATOR,

STAKE,

UNSTAKE,

REMOVE_AUTHORIZED_PARTY,

STAKE_AUTHORIZE_WITH_SEED,

SLASH,

COINBASE_DEPOSIT,

CONVERSION,

CLAIM_REWARDS,

VOTE_AUTHORIZE,

WEB3_TRANSACTION,

ONCHAIN_TRANSACTION,

PORTFOLIO_STAKE,

PORTFOLIO_UNSTAKE

transaction.status

enum<string>

UNKNOWN_TRANSACTION_STATUS: An Unknown Transaction status
TRANSACTION_CREATED: The Transaction has been created and is awaiting Consensus approval This is a non-terminal status
TRANSACTION_REQUESTED: The Transaction has reached User Consensus and is awaiting Coinbase Prime approval This is a non-terminal status
TRANSACTION_APPROVED: The Transaction has been authorized by Coinbase Prime This is a non-terminal status
TRANSACTION_GASSING: The transaction is awaiting blockchain resources for broadcast This is a non-terminal status
TRANSACTION_GASSED: The transaction has received blockchain resources for broadcasting This is a non-terminal status
TRANSACTION_PROVISIONED: The transaction has been provisioned and is awaiting planning This is a non-terminal status
TRANSACTION_PLANNED: The transaction has been constructed. This is a non-terminal status
TRANSACTION_PROCESSING: The transaction is currently processing and awaiting finalization This is a non-terminal status
TRANSACTION_RESTORED: The transaction has been broadcasted to the network. This is a non-terminal status
TRANSACTION_DONE: The transaction has confirmed on-chain and finished. This is a terminal status
TRANSACTION_IMPORT_PENDING: The transaction deposit has been detected and is awaiting finalization. This is a non-terminal status
TRANSACTION_IMPORTED: The transaction deposit and reward has been detected. This is a terminal status
TRANSACTION_CANCELLED: The transaction has been cancelled This is a terminal status
TRANSACTION_REJECTED: The transaction was rejected before construction and broadcasting. This is a terminal status
TRANSACTION_DELAYED: The transaction s taking longer than expected to confirm on-chain. This is a non-terminal status
TRANSACTION_RETRIED: The transaction has been recreated and retried, this occurs when network congestion results in transfers becoming extremely delayed due to insufficient fees or network resources such as CPU, RAM, or NET This is a terminal status
TRANSACTION_FAILED: The transaction failed on-chain (the fee was spent but the operation failed). This is a terminal status
TRANSACTION_EXPIRED: The transaction has expired. This is a terminal status
TRANSACTION_BROADCASTING: The transaction is currently broadcasting to the cryptocurrency network. This is a non-terminal status
OTHER_TRANSACTION_STATUS: The transaction has reached an OTHER status. This is a non-terminal status
TRANSACTION_CONSTRUCTED: The transaction bctx is constructed but not yet broadcasting on chain This is a non-terminal status

Available options:

TRANSACTION_CREATED,

TRANSACTION_REQUESTED,

TRANSACTION_APPROVED,

TRANSACTION_GASSING,

TRANSACTION_GASSED,

TRANSACTION_PROVISIONED,

TRANSACTION_PLANNED,

TRANSACTION_PROCESSING,

TRANSACTION_RESTORED,

TRANSACTION_DONE,

TRANSACTION_IMPORT_PENDING,

TRANSACTION_IMPORTED,

TRANSACTION_CANCELLED,

TRANSACTION_REJECTED,

TRANSACTION_DELAYED,

TRANSACTION_RETRIED,

TRANSACTION_FAILED,

TRANSACTION_EXPIRED,

TRANSACTION_BROADCASTING,

OTHER_TRANSACTION_STATUS,

TRANSACTION_CONSTRUCTED

transaction.symbol

string

The asset symbol

Example:

"BTC"

transaction.created_at

string<date-time>

The transaction creation time (as a UTC timestamp)

Example:

"2021-05-31T11:59:59.000Z"

transaction.completed_at

string<date-time>

The transaction completion time (as a UTC timestamp)

Example:

"2021-05-31T12:09:31.000Z"

transaction.amount

string

The transaction amount in whole units

Example:

"100"

transaction.transfer_from

object

Show child attributes

transaction.transfer_from.type

enum<string>

Available options:

PAYMENT_METHOD,

WALLET,

ADDRESS,

OTHER,

MULTIPLE_ADDRESSES,

COUNTERPARTY_ID

transaction.transfer_from.value

string

The value of the transfer location: payment method ID, wallet ID or crypto address

Example:

"0bf7bf1e-bafa-4d7e-9312-fa0bf3b63f27"

transaction.transfer_from.address

string

The crypto address of the transfer location

Example:

6.6325114945411165e+47

transaction.transfer_from.account_identifier

string

The tag/memo of the address, if applicable -- required for certain assets (e.g. XRP, XLM, etc.)

Example:

"387879289"

transaction.transfer_to

object

Show child attributes

transaction.transfer_to.type

enum<string>

Available options:

PAYMENT_METHOD,

WALLET,

ADDRESS,

OTHER,

MULTIPLE_ADDRESSES,

COUNTERPARTY_ID

transaction.transfer_to.value

string

The value of the transfer location: payment method ID, wallet ID or crypto address

Example:

"0bf7bf1e-bafa-4d7e-9312-fa0bf3b63f27"

transaction.transfer_to.address

string

The crypto address of the transfer location

Example:

6.6325114945411165e+47

transaction.transfer_to.account_identifier

string

The tag/memo of the address, if applicable -- required for certain assets (e.g. XRP, XLM, etc.)

Example:

"387879289"

transaction.network_fees

string

The blockchain network fees (in whole units) required in order to broadcast the transaction

Example:

"1.99"

transaction.fees

string

The fees that the customer paid for the transaction (in whole units)

Example:

"4.53"

transaction.fee_symbol

string

The asset in which fees will be paid

Example:

"USD"

transaction.blockchain_ids

string[]

The cryptocurrency network transaction hashes/IDs generated upon broadcast

Example:

[7.004643996595406e+76]

transaction.transaction_id

string

The 8 character alphanumeric short form id for the transaction

Example:

"A1B2C3D4"

transaction.destination_symbol

string

The destination asset symbol

Example:

"USD"

transaction.estimated_network_fees

object

Show child attributes

transaction.estimated_network_fees.lower_bound

string

Estimated lower bound for networks fees (in whole units)

Example:

"1.99"

transaction.estimated_network_fees.upper_bound

string

Estimated upper bound for network fees (in whole units)

Example:

"2.99"

transaction.network

string

The network name specific to web3/onchain wallet transactions

Example:

"ethereum-mainnet"

transaction.estimated_asset_changes

object[]

The estimated asset changes (web3)

Show child attributes

type

enum<string>

Available options:

BALANCE_TRANSFER,

BALANCE_APPROVAL,

ITEM_TRANSFER,

ITEM_APPROVAL,

ITEM_APPROVAL_ALL

symbol

string

The currency symbol associated with the balance operation

Example:

"ETH"

amount

string

The amount in whole units being transferred or approved

Example:

"100"

collection

object

Show child attributes

collection.name

string

NFT collection name

item

object

Show child attributes

item.name

string

NFT item name

transaction.metadata

object

Show child attributes

transaction.metadata.match_metadata

object

Show child attributes

transaction.metadata.match_metadata.reference_id

string

The reference id of the match

transaction.metadata.match_metadata.settlement_date

string

The settlement date of the match

transaction.metadata.web3_transaction_metadata

object

Show child attributes

transaction.metadata.web3_transaction_metadata.label

string

The transaction type label of the confirmed transaction post settlement

transaction.metadata.web3_transaction_metadata.confirmed_asset_changes

object[]

The confirmed asset changes (onchain)

Show child attributes

type

enum<string>

Available options:

BALANCE_TRANSFER,

BALANCE_APPROVAL,

ITEM_TRANSFER,

ITEM_APPROVAL,

ITEM_APPROVAL_ALL

symbol

string

The currency symbol associated with the balance operation

Example:

"ETH"

amount

string

The amount in whole units being transferred or approved

Example:

"100"

collection

object

Show child attributes

collection.name

string

NFT collection name

item

object

Show child attributes

item.name

string

NFT item name

transaction.metadata.reward_metadata

object

Show child attributes

transaction.metadata.reward_metadata.subtype

enum<string>

REWARD_SUBTYPE_UNKNOWN: An unknown reward subtype, reward subtype may not be supported in the API response yet
MEV_REWARD: A maximal extractable value reward i.e. sol mev rewards
INFLATION_REWARD: An inflationary reward i.e. solana inflationary rewards
BLOCK_REWARD: A block reward i.e. solana block rewards
VALIDATOR_REWARD: A validator reward i.e. ethereum validator (consensus layer) rewards
TRANSACTION_REWARD: A transaction reward i.e. ethereum transaction (execution layer) rewards
STAKING_FEE_REBATE_REWARD: A staking fee rebate reward i.e. coinbase pays rebates for staking fees to eligible delegators

Available options:

MEV_REWARD,

INFLATION_REWARD,

BLOCK_REWARD,

VALIDATOR_REWARD,

TRANSACTION_REWARD,

STAKING_FEE_REBATE_REWARD

transaction.idempotency_key

string

The idempotency key associated with the transaction creation request

transaction.onchain_details

object

Show child attributes

transaction.onchain_details.signed_transaction

string

The signed transaction data

Example:

"01ac1872bb2967df00124a7fd15e470a10aab04852e19fc6f..."

transaction.onchain_details.risk_assessment

New message for risk assessment details · object

Show child attributes

transaction.onchain_details.risk_assessment.compliance_risk_detected

boolean

Indicates if the transaction has been flagged for compliance concerns

Example:

false

transaction.onchain_details.risk_assessment.security_risk_detected

boolean

Indicates if the transaction has been flagged for security concerns

Example:

false

transaction.onchain_details.chain_id

string

The blockchain network chain ID. Will be empty for Solana transactions.

Example:

"1"

transaction.onchain_details.nonce

string

The transaction nonce. Only present for EVM-based blockchain transactions.

Example:

"42"

transaction.onchain_details.replaced_transaction_id

string

The ID of the transaction that this transaction replaced

Example:

"123e4567-e89b-12d3-a456-426614174000"

transaction.onchain_details.destination_address

string

The destination address for the transaction

Example:

6.6325114945411165e+47

transaction.onchain_details.skip_broadcast

boolean

If set to true, the transaction will not be broadcast to the network. You can still retrieve the signed transaction from the GetTransaction endpoint by transaction ID once the transaction is created.

Example:

false

transaction.onchain_details.failure_reason

string

Reason for transaction failure if applicable

Example:

"insufficient_funds"

transaction.onchain_details.signing_status

enum<string>

Available options:

SIGNED,

UNSIGNED

transaction.network_info

object

Show child attributes

transaction.network_info.id

string

The network id: base, bitcoin, ethereum, solana etc

transaction.network_info.type

string

The network type: mainnet, testnet, etc

transaction.process_requirements

Represents the status of various process requirements for a transaction · object

Show child attributes

transaction.process_requirements.travel_rule_status

enum<string>

default:TRAVEL_RULE_STATUS_UNSPECIFIED

Available options:

TRAVEL_RULE_STATUS_UNSPECIFIED,

TRAVEL_RULE_STATUS_PENDING,

TRAVEL_RULE_STATUS_SUBMITTED

REST API

FIX API

Websocket Feed

Path Parameters

Response