Get transaction details

Authorizations

X-Processing-Key

string

header

required

Your API key.

Headers

X-Processing-Signature

string

required

Hex-encoded HMAC-SHA512 signature of the request body, generated using your secret key.

Body

application/json

By ID
By foreign ID
By transaction hash

integer

required

The transaction's ID, a number. It's the id in the response to the request that created the transaction, and in the transaction's callbacks. Use it to find a deposit, or one specific transaction among several with the same txid.

Required range: x >= 1

Example:

717535

Response

The response has the same fields as the transaction's callback, except a few that only callbacks have, such as origin in the callbacks for top-ups of your merchant wallet and a deposit's sender. Use it to check a transaction's status, or to get the details of a callback your server missed.

integer

required

Transaction ID, the same id as in the transaction's callbacks.

Required range: x >= 1

Example:

717535

type

string

required

Transaction type, the same as in the transaction's callback:

withdrawal: a withdrawal without conversion.
withdrawal_exchange: a withdrawal with conversion.
withdrawal_instant: an instant withdrawal without conversion.
withdrawal_instant_exchange: an instant withdrawal with conversion.
exchange: an exchange.
deposit: a deposit without conversion.
deposit_exchange: a deposit converted to another currency.
deposit_wallet_client: a top-up of your merchant wallet.
withdrawal_to_cold_client: an automatic withdrawal to your cold address.

Example:

"withdrawal"

transactions

object[]

required

Transaction entries. Each entry has a transaction_type that determines which fields are present:

blockchain: On-chain transactions (has address, tag, txid and confirmations, and can have riskscore)
internal: Transfers between addresses managed by the platform (has address, tag, txid, confirmations). The txid is an internal transfer ID rather than a blockchain hash, shared by the withdrawal and the deposit it produces.
exchange: Currency exchanges (has currency_to, amount_to)

Hide child attributes

transactions.id

integer

required

ID of this entry, not of the transaction. To look up the transaction, use the top-level id.

transactions.currency

string

required

Code of the entry's currency: the currency sent or received at the address, or, for an exchange entry, the currency converted from.

transactions.transaction_type

enum<string>

required

Available options:

blockchain,

internal,

exchange

transactions.type

string

required

What the entry records:

deposit: funds received at the address, in the blockchain or internal entry of a deposit.
deposit_wallet_client: funds received at a top-up address of your merchant wallet.
withdrawal: funds sent to the address, in the blockchain or internal entry of any withdrawal, instant withdrawals included.
withdrawal_to_cold_client: funds sent to your cold address by an automatic withdrawal.
exchange: a conversion between currencies, in an exchange entry: the exchange itself, or the conversion of a deposit or withdrawal with conversion.

transactions.amount

string

required

Amount of the entry, in currency: the amount sent or received at the address, or, for an exchange entry, the amount converted.

transactions.currency_to

string

Destination currency. Present only for exchange entries.

transactions.address

string

Cryptocurrency address. Present for blockchain and internal entries.

transactions.tag

string | null

Destination tag. Present for blockchain and internal entries.

transactions.amount_to

string

Amount obtained from the conversion, in currency_to, before fees. Present only for exchange entries.

transactions.txid

string | null

Transaction hash, or the internal transfer ID for internal entries. null until a withdrawal is sent to the blockchain.

transactions.riskscore

string | null

Risk score (0-100). Only blockchain entries can have one; it's null or omitted when the transaction wasn't scored.

transactions.confirmations

string

Number of blockchain confirmations. Present for blockchain and internal entries; always "0" for internal entries.

fees

object[]

required

Hide child attributes

fees.type

string

required

Fee type identifier, for example mining, fee_crypto_deposit, fee_crypto_deposit_internal, fee_crypto_deposit_to_fiat_internal, fee_crypto_deposit_wallet_client, fee_crypto_withdrawal_from_crypto, fee_crypto_sell_for_fiat or fee_crypto_exchange_to_crypto. fees is an empty array when no fee was charged.

fees.currency

string

required

Fee currency ISO code.

fees.amount

string

required

Fee amount. Returns '0' when system pays network fees.

error

string | null

required

Empty string, unless the transaction was cancelled, declined or failed: then the reason, for example Withdrawal to the address `<address>` is forbidden.

status

enum<string>

required

Transaction status:

verifying: the transaction was accepted and is being checked.
not_confirmed: the transaction is being processed: waiting for blockchain confirmations, or, for a withdrawal, to be sent to the blockchain (txid can still be null).
pending: the withdrawal is waiting for approval in the portal.
confirmed, cancelled, declined: final statuses.

Callbacks aren't sent for verifying or, for withdrawals, not_confirmed, so this endpoint is the only way to see them.

Available options:

verifying,

not_confirmed,

pending,

confirmed,

cancelled,

declined

foreign_id

string | null

The withdrawal's unique identifier in your system. Present only for withdrawals, and null for an automatic withdrawal to a cold address; omitted for deposits and exchanges (an exchange can still be found by its foreign_id).

end_user_reference

string | null

For a withdrawal, the end_user_reference from the request that created it; for a deposit, the end_user_reference of the deposit address. Omitted for exchanges, and for a deposit to an address that has none. Can be null for some deposits, such as top-ups of your merchant wallet.

crypto_address

object

Address details: the destination of a withdrawal, or the address that received a deposit. Omitted for exchanges.

Hide child attributes

crypto_address.id

integer

required

Address ID. For a deposit in a different currency than the one assigned to the address (a cross-currency deposit), this is the ID of a separate record for the deposited currency, not the id that /v2/addresses/take returned, so use foreign_id to identify the address.

Required range: x >= 1

Example:

176

crypto_address.currency

string

required

Code of the address's currency: the currency sent to the address by a withdrawal, or the deposited currency. For a cross-currency deposit, this is the currency actually deposited, not the one assigned to the address.

Example:

"BTC"

crypto_address.address

string

required

The withdrawal's destination address, or the address that received the deposit.

Minimum string length: 1

Example:

"bc1qgussp48sq8mwz040dz49pjy6nauu6sucxjwylm"

crypto_address.tag

string | null

required

Destination tag or memo. null if the transaction has none, for example for a currency that doesn't use one.

crypto_address.convert_to

string

Conversion target currency. Present only when address has conversion logic.

Example:

"USD"

crypto_address.foreign_id

string

The foreign_id of the deposit address. Present only for deposits to an address from /v2/addresses/take. Use it to identify which customer made the deposit, also for a cross-currency deposit.

currency_sent

object

The currency and amount the transaction starts from: for a deposit, what the customer sent; for a withdrawal, the amount withdrawn (in the currency converted from, for a withdrawal with conversion); for an exchange, the currency exchanged from. Omitted while a withdrawal is pending approval, and for a cancelled or declined withdrawal.

Hide child attributes

currency_sent.currency

string

required

Currency ISO code.

currency_sent.amount

string

required

Amount sent, in currency.

currency_received

object

The currency and amount the transaction results in: for a deposit, the amount received (after the conversion, for a deposit with conversion), before fees; for a withdrawal, what's sent to the address; for an exchange, the currency exchanged to, before fees. Omitted in the same cases as currency_sent. For a withdrawal with conversion that's still verifying, amount can be 0.00000000 until the exchange is done.

Hide child attributes

currency_received.currency

string

required

Currency ISO code.

currency_received.amount

string

required

Amount received, in currency.

currency_received.amount_minus_fee

string

Amount received minus fees. Present only for deposits (every deposit* type).

additional_details

object | null

Additional transaction details. Present only when available.

Reference

Deposits

Withdrawals

Payment requests

Exchanges

Currencies

Transactions

Account balance

System Health

Authorizations

Headers

Body

Response