CoinPayments Documentation

Wallet Webhook Payload

This is the webhook payload sent to your server once you have configured wallet webhooks. One delivery is sent per transaction update — including one on every new on-chain confirmation — so the same transaction will produce several payloads as it progresses.

The transactionType and transactionStatus fields are documented on transaction type and transaction status — see those references for what every value means.

walletIdstring

wallet id

Example4ca18e8e-915b-4a69-a17a-0b0b666858a7

addressstring

wallet address involved into the transaction performance

ExamplemyGTmrMtU6vUULkYRCDxJMggF7egsXhcTi

transactionIdstring

id of the transaction that is being executed

Examplecb44e78f-a97b-44b5-a23d-1e3b025aab47

txHashstring

Blockchain transaction hash (external tx). The transaction hash is subject to change until the transaction is marked as `confirmed`.

Example9d9dd1f6f4a62388797e6beeb76c1a3c34d41942303ce6fb49177d3c88a74d11

spendRequestIdstring

id of the withdrawal spend request. Is applied only for withdrawal and conversion transactions

Example448c1624-98e7-43c9-85f4-75ed0c97a8bb

transactionTypestring

type of the transaction that is being executed, in PascalCase. See Transaction Types for what each value means.

ExampleExternalSpendEnumUnknownInternalReceiveUtxoExternalReceiveAccountBasedExternalReceiveExternalSpendInternalSpendSameUserSpendSameUserReceiveAccountBasedExternalTokenReceiveAccountBasedTokenSpendConversionAutoSweepingReceiveTestFundsFromPoolReturnTestFundsToPool

transactionStatusstring

status of the transaction at the time of the webhook, in PascalCase. External transactions (deposits/withdrawals) finish at ConfirmedOnBlockchain; internal transactions finish at Completed. See Transaction Statuses for the full lifecycle.

ExampleConfirmedOnBlockchainEnumUnknownCreatedPendingProcessingCompletedExpiredFailedConfirmedOnBlockchainPendingReceiveFailedOnBlockchainCancelledRejected

amountinteger

net transaction amount in crypto

symbolstring

currency of the transaction

coinPaymentsFeeinteger

transaction fee charged by CoinPayments

coinPaymentsFeeSymbolstring

currency of the transaction fee charged by CoinPayments in crypto

blockchainFeestring

network fee in crypto

blockchainFeeSymbolstring

currency of the network fee

totalAmountstring

gross transaction amount in crypto

totalAmountSymbolstring

currency of the gross transaction amount

nativeAmountinteger

net transaction amount in fiat

coinPaymentsFeeNativeAmountstring

CP fee amount in fiat

blockchainFeeNativeAmountstring

network fee amount in fiat

totalNativeAmountstring

gross transaction amount in fiat

nativeSymbolstring

fiat currency of the transaction amount and fees

confirmationsinteger

amount of confirmations gathered by the transaction on chain. Deposits require a specific number of blockchain confirmations to release the funds for payout. Crediting funds to the customer prior to receiving the full number of confirmations shall be done at merchant's own risk.

requiredConfirmationsinteger

amount of confirmations required for the transaction on chain to be considered completed. Deposits require a specific number of blockchain confirmations to release the funds for payout. Crediting funds to the customer prior to receiving the full number of confirmations shall be done at merchant's own risk.