> For the complete documentation index, see [llms.txt](https://developers.coincircuit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.coincircuit.io/webhooks/readme/payouts.md).

# Payouts

Payout webhook events and example payloads.

Payout webhooks track outgoing transfers to recipients.

The examples on this page show crypto payouts.

### Field descriptions

Payout webhook events use `data.payout`.

| Field                       | Type             | Description                                  |
| --------------------------- | ---------------- | -------------------------------------------- |
| `data.payout.id`            | `string`         | Unique payout identifier.                    |
| `data.payout.method`        | `string`         | Payout method.                               |
| `data.payout.type`          | `string`         | Payout type.                                 |
| `data.payout.status`        | `string`         | Payout status.                               |
| `data.payout.amount`        | `string`         | Net payout amount.                           |
| `data.payout.fee`           | `string`         | Fee charged.                                 |
| `data.payout.total`         | `string`         | Total debited amount.                        |
| `data.payout.currency`      | `string`         | Payout currency.                             |
| `data.payout.reference`     | `string \| null` | External reference.                          |
| `data.payout.narration`     | `string \| null` | Payout narration.                            |
| `data.payout.recipient`     | `object`         | Recipient details.                           |
| `data.payout.txHash`        | `string \| null` | Blockchain transaction hash when available.  |
| `data.payout.createdAt`     | `string`         | Creation timestamp.                          |
| `data.payout.updatedAt`     | `string`         | Last update timestamp.                       |
| `data.payout.completedAt`   | `string \| null` | Completion timestamp for successful payouts. |
| `data.payout.failureReason` | `string \| null` | Failure reason for failed payouts.           |

### Events

* `payout.created`
* `payout.success`
* `payout.failed`

### `payout.created`

Sent when a payout is created.

Use this event to track payout initiation.

```json
{
  "event": "payout.created",
  "data": {
    "payout": {
      "id": "po_123",
      "method": "crypto",
      "type": "withdrawal",
      "status": "pending",
      "amount": "99.50",
      "fee": "0.50",
      "total": "100.00",
      "currency": "USDT",
      "reference": "PAY-ABC123DEF456",
      "narration": "Withdrawal payout",
      "recipient": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "cryptoAddress",
        "address": "0x1234567890abcdef1234567890abcdef12345678",
        "chain": "ethereum",
        "asset": "USDT",
        "accountName": null,
        "accountNumber": null,
        "bankName": null
      },
      "txHash": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  }
}
```

### `payout.success`

Sent when a payout is delivered successfully.

Use this event to close the payout in your ledger.

```json
{
  "event": "payout.success",
  "data": {
    "payout": {
      "id": "po_123",
      "method": "crypto",
      "type": "withdrawal",
      "status": "success",
      "amount": "99.50",
      "fee": "0.50",
      "total": "100.00",
      "currency": "USDT",
      "reference": "PAY-ABC123DEF456",
      "narration": "Withdrawal payout",
      "recipient": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "cryptoAddress",
        "address": "0x1234567890abcdef1234567890abcdef12345678",
        "chain": "ethereum",
        "asset": "USDT",
        "accountName": null,
        "accountNumber": null,
        "bankName": null
      },
      "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
      "completedAt": "2024-01-15T10:40:00.000Z",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:40:00.000Z"
    }
  }
}
```

### `payout.failed`

Sent when a payout fails.

Use this event to stop reconciliation and surface the error.

{% hint style="danger" %}
Check `data.payout.failureReason` for the failure reason.
{% endhint %}

```json
{
  "event": "payout.failed",
  "data": {
    "payout": {
      "id": "po_123",
      "method": "crypto",
      "type": "withdrawal",
      "status": "failed",
      "amount": "99.50",
      "fee": "0.50",
      "total": "100.00",
      "currency": "USDT",
      "reference": "PAY-ABC123DEF456",
      "narration": "Withdrawal payout",
      "recipient": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "cryptoAddress",
        "address": "0x1234567890abcdef1234567890abcdef12345678",
        "chain": "ethereum",
        "asset": "USDT",
        "accountName": null,
        "accountNumber": null,
        "bankName": null
      },
      "txHash": null,
      "failureReason": "Invalid address",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developers.coincircuit.io/webhooks/readme/payouts.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.