payout.failed

The payout paid nothing and will not be retried: it was refused, canceled, or its transaction failed (failure_code).

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 payout.failed.
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.id	string
data.object.status	string	One of pending, processing, included, confirmed, failed.
data.object.network	string
data.object.asset	string
data.object.asset_id	string
data.object.contract optional	string
data.object.decimals	integer
data.object.amount	string	What the destination receives, base units of asset. A whole number written as a string of digits.
data.object.destination	string
data.object.memo optional	string
data.object.tx_hash optional	string
data.object.refund_id optional	string	Set when the payout pays a refund.
data.object.failure_code optional	string	Why a failed payout failed.
data.object.requested_by	object
data.object.requested_by.type	string	One of user, apiKey.
data.object.requested_by.id	string
data.object.created_at	string (date-time)
data.object.confirmed_at optional	string (date-time)
data.object.failed_at optional	string (date-time)

A field marked optional can be missing from a payload.

Example

{
  "id": "string",
  "type": "payout.failed",
  "api_version": "v1",
  "created": 0,
  "livemode": true,
  "data": {
    "object": {
      "id": "string",
      "status": "failed",
      "network": "string",
      "asset": "string",
      "asset_id": "string",
      "contract": "string",
      "decimals": 0,
      "amount": "1000000",
      "destination": "string",
      "memo": "string",
      "tx_hash": "string",
      "refund_id": "string",
      "failure_code": "string",
      "requested_by": {
        "type": "user",
        "id": "string"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "confirmed_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.