deposit.payment_released

A payment to a deposit address was swept to the master wallet.

cTpeWay sends this event as an HTTP POST to every webhook endpoint subscribed to it. Verify the signature before you trust the body: see Webhooks.

Payload

Field	Type	Description
id	string	Unique event id, evt_…. Use it to deduplicate deliveries.
type	string	Always deposit.payment_released.
api_version	string	Always v1.
created	integer	Unix time in seconds.
livemode	boolean	false for events from the test environment.
data	object
data.object	object
data.object.deposit_address	object
data.object.deposit_address.id	string
data.object.deposit_address.name optional	string
data.object.deposit_address.network	string
data.object.deposit_address.address	string
data.object.deposit_address.status	string	One of active, disabled, archived.
data.object.deposit_address.created_at	string (date-time)
data.object.payment	object
data.object.payment.id	string
data.object.payment.status	string	One of detected, confirmed, orphaned, dropped.
data.object.payment.invoice_id optional	string
data.object.payment.option_id optional	string
data.object.payment.deposit_address_id optional	string
data.object.payment.network	string
data.object.payment.asset	string
data.object.payment.asset_id	string
data.object.payment.contract optional	string
data.object.payment.decimals	integer
data.object.payment.address	string
data.object.payment.from_address optional	string
data.object.payment.tx_hash optional	string	The transaction that paid. Absent while the payment is known only from a balance change (detected_by: balance) and its transaction has not been identified; payment.transaction_attached announces it. A simulated payment (test mode, simulated: true) carries its sim_… id here.
data.object.payment.tx_index optional	integer	Position of the transfer inside the transaction. Present exactly when tx_hash is.
data.object.payment.amount	string	A whole number written as a string of digits.
data.object.payment.confirmations	integer
data.object.payment.block_height optional	integer
data.object.payment.block_hash optional	string
data.object.payment.usd_value optional	string	Value at the price snapshot taken at confirmation. A decimal number written as a string, with up to 8 decimal places.
data.object.payment.late	boolean	Confirmed after the invoice had expired or been canceled.
data.object.payment.simulated	boolean
data.object.payment.detected_by	string	How the payment was found, fixed when it is first seen: poll (its transaction was seen while watching the address), hint (its transaction was reported through the checkout and found on the network), balance (the address’s balance rose; the transaction is identified later, and tx_hash is absent until then), simulated (test mode). One of poll, hint, balance, simulated.
data.object.payment.detected_at	string (date-time)
data.object.payment.confirmed_at optional	string (date-time)
data.object.payment.settlement optional	object
data.object.payment.settlement.id	string
data.object.payment.settlement.status	string	One of pending, held, releasing, released, failed, reverted.
data.object.settlement	object
data.object.settlement.id	string
data.object.settlement.status	string	One of pending, held, releasing, released, failed, reverted.
data.object.settlement.payment_id	string
data.object.settlement.invoice_id optional	string
data.object.settlement.deposit_address_id optional	string
data.object.settlement.network	string
data.object.settlement.asset	string
data.object.settlement.asset_id	string
data.object.settlement.native_asset	string
data.object.settlement.gross	string	The deposit, base units of asset. A whole number written as a string of digits.
data.object.settlement.usd_value	string	A decimal number written as a string, with up to 8 decimal places.
data.object.settlement.fee_bps	integer
data.object.settlement.fee_native	string	Platform fee owed, base units of native_asset. A whole number written as a string of digits.
data.object.settlement.fee_source	string	One of deposit, master.
data.object.settlement.fee_paid	string	A whole number written as a string of digits.
data.object.settlement.fee_carried	string	A whole number written as a string of digits.
data.object.settlement.required_native optional	string	Native coin the master wallet must hold for this release. A whole number written as a string of digits.
data.object.settlement.master_wallet_address optional	string
data.object.settlement.reason optional	string	Why it is held (status held) or why it failed (status failed); absent in any other status. insufficient_master_balance: Held: the master wallet has too little native coin to pay the platform fee and the network costs of the release (token deposits). Released by itself once the wallet is topped up. uneconomic: Held: the network fee of the release is estimated at more than half of what the deposit is worth. Looked at again on every planning run and released when the estimate falls. below_sweep_min: Held: the deposit is worth less than the merchant’s minimum for a sweep. It stays in its address until that setting allows it or another release from the same address takes it along. payment_orphaned: Failed: a chain reorganisation removed the payment while its release was under way. The settlement returns to the queue by itself if the payment confirms again. funds_missing: Failed: the deposit is no longer at its address and no release on record moved it. Needs an operator. not_releasable: Failed: the network cannot release this deposit as it stands (an asset or address it does not support, or a release plan that did not pass its checks). Needs an operator. transaction_failed: Failed: a transaction of the release was rejected or can no longer be included. Retried by an operator; what was already paid is not paid again. replanning: Failed for a moment: a transaction prepared for the release could not be used as it was, and the release is being planned again by itself. Nothing to do. unclassified: Failed: for a reason outside this list. Needs an operator. One of insufficient_master_balance, uneconomic, below_sweep_min, payment_orphaned, funds_missing, not_releasable, transaction_failed, replanning, unclassified.
data.object.settlement.fee_tx optional	string
data.object.settlement.topup_tx optional	string
data.object.settlement.sweep_tx optional	string
data.object.settlement.network_fees	string	A whole number written as a string of digits.
data.object.settlement.net_released optional	string	A whole number written as a string of digits.
data.object.settlement.simulated	boolean
data.object.settlement.confirmed_at	string (date-time)
data.object.settlement.held_since optional	string (date-time)
data.object.settlement.released_at optional	string (date-time)
data.object.settlement.failed_at optional	string (date-time)

A field marked optional can be missing from a payload.

Example

{
  "id": "string",
  "type": "deposit.payment_released",
  "api_version": "v1",
  "created": 0,
  "livemode": true,
  "data": {
    "object": {
      "deposit_address": {
        "id": "string",
        "name": "string",
        "network": "string",
        "address": "string",
        "status": "active",
        "created_at": "2026-01-01T00:00:00.000Z"
      },
      "payment": {
        "id": "string",
        "status": "detected",
        "invoice_id": "string",
        "option_id": "string",
        "deposit_address_id": "string",
        "network": "string",
        "asset": "string",
        "asset_id": "string",
        "contract": "string",
        "decimals": 0,
        "address": "string",
        "from_address": "string",
        "tx_hash": "string",
        "tx_index": 0,
        "amount": "1000000",
        "confirmations": 0,
        "block_height": 0,
        "block_hash": "string",
        "usd_value": "10.00",
        "late": true,
        "simulated": true,
        "detected_by": "poll",
        "detected_at": "2026-01-01T00:00:00.000Z",
        "confirmed_at": "2026-01-01T00:00:00.000Z",
        "settlement": {
          "id": "string",
          "status": "pending"
        }
      },
      "settlement": {
        "id": "string",
        "status": "pending",
        "payment_id": "string",
        "invoice_id": "string",
        "deposit_address_id": "string",
        "network": "string",
        "asset": "string",
        "asset_id": "string",
        "native_asset": "string",
        "gross": "1000000",
        "usd_value": "10.00",
        "fee_bps": 0,
        "fee_native": "1000000",
        "fee_source": "deposit",
        "fee_paid": "1000000",
        "fee_carried": "1000000",
        "required_native": "1000000",
        "master_wallet_address": "string",
        "reason": "insufficient_master_balance",
        "fee_tx": "string",
        "topup_tx": "string",
        "sweep_tx": "string",
        "network_fees": "1000000",
        "net_released": "1000000",
        "simulated": true,
        "confirmed_at": "2026-01-01T00:00:00.000Z",
        "held_since": "2026-01-01T00:00:00.000Z",
        "released_at": "2026-01-01T00:00:00.000Z",
        "failed_at": "2026-01-01T00:00:00.000Z"
      }
    }
  }
}

The values are placeholders generated from the schema. They show the shape, not real data.