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

# Payout webhooks

Txn sends a payout webhook each time a payout's `status` changes. The payload mirrors the [Read payout](https://docs.txn.io/payouts/reading-payout.md) endpoint response, including the `accounts` and `apiKeys` entities in `included[]`; the **Response Body** table on that page describes every field. `included[]` carries no `apiKeys` entity when the payout was created in the dashboard, including mass payouts.

The tabs below show example payloads for each status. For the rules that govern transitions, see [Payout status flow](https://docs.txn.io/payouts/payout-status-flow.md).

For configuring webhook URLs, retry behaviour, source IPs, and signature verification, see the general [Webhooks](https://docs.txn.io/api-basics/webhooks.md) section.

{% hint style="info" %}
For Binance Pay payouts, `binanceOrderId` can be set some time after the payout's `status` changes to `completed`, so the `completed` webhook may carry `null`. Txn does not send another webhook when the value is set. Use [Read payout](https://docs.txn.io/payouts/reading-payout.md) to get it.
{% endhint %}

{% tabs %}
{% tab title="Status Processing" %}

```json
{
  "data": {
    "attributes": {
      "absorbFees": null,
      "absorbNetworkFee": true,
      "absorbPayoutFee": true,
      "address": "TTesiim14FHGyRWAx9tD4RQM2e4LxMgLV2",
      "amount": "12.000000",
      "amountCharged": "13.220000",
      "amountChargedCurrency": "USDT",
      "approvalStatus": null,
      "binanceOrderId": null,
      "binanceStatus": null,
      "createdAt": "2026-11-04T12:29:45.014Z",
      "currency": "USDT",
      "displayFee": "0.120000",
      "displayFeeCurrency": "USDT",
      "exchangeRate": "1.0",
      "expiresAt": "2026-11-04T12:30:15.014Z",
      "networkFee": "1.100000",
      "networkFeeCurrency": "USDT",
      "payAmount": "12.000000",
      "payChargeRate": "1.0",
      "payChargeRateCurrency": "USDT",
      "payCurrency": "USDT",
      "payNetwork": "ttrx:usdt",
      "payNetworkName": "Tron (TRC20)",
      "paymentMethod": "on_chain",
      "payoutFee": "0.120000",
      "payoutFeeCurrency": "USDT",
      "receiverBinanceId": null,
      "reference": "docs-webhook-invoice-1793795384",
      "status": "processing",
      "txid": null
    },
    "id": "7c5841a1-470f-4a11-83dc-eb70d3d196f1",
    "relationships": {
      "accountCharged": {
        "data": {
          "id": "e289de2b-37bd-4eff-b832-f754c31a2d95",
          "type": "accounts"
        }
      },
      "author": {
        "data": {
          "id": "6038417d-7774-414c-9d81-d0c8ab1c3ed7",
          "type": "apiKeys"
        }
      }
    },
    "type": "payouts"
  },
  "included": [
    {
      "attributes": {
        "balance": "306087.739778",
        "bankDepositAvailable": false,
        "bankReference": "BDR4180381621673581",
        "bankWithdrawalAvailable": false,
        "currencyCode": "USDT",
        "currencyType": "crypto",
        "label": "master",
        "master": true,
        "totalBalance": null,
        "transferAvailable": true
      },
      "id": "e289de2b-37bd-4eff-b832-f754c31a2d95",
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        },
        "txnBankCredentials": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "accounts"
    },
    {
      "attributes": {
        "createdAt": "2026-11-03T17:57:41.705Z",
        "name": "CL"
      },
      "id": "6038417d-7774-414c-9d81-d0c8ab1c3ed7",
      "type": "apiKeys"
    }
  ],
  "meta": {}
}
```

{% endtab %}

{% tab title="Status Completed" %}

```json
{
  "data": {
    "attributes": {
      "absorbFees": null,
      "absorbNetworkFee": true,
      "absorbPayoutFee": true,
      "address": "TTesiim14FHGyRWAx9tD4RQM2e4LxMgLV2",
      "amount": "12.000000",
      "amountCharged": "13.220000",
      "amountChargedCurrency": "USDT",
      "approvalStatus": null,
      "binanceOrderId": null,
      "binanceStatus": null,
      "createdAt": "2026-11-04T12:29:45.014Z",
      "currency": "USDT",
      "displayFee": "0.120000",
      "displayFeeCurrency": "USDT",
      "exchangeRate": "1.0",
      "expiresAt": "2026-11-04T12:30:15.014Z",
      "networkFee": "1.100000",
      "networkFeeCurrency": "USDT",
      "payAmount": "12.000000",
      "payChargeRate": "1.0",
      "payChargeRateCurrency": "USDT",
      "payCurrency": "USDT",
      "payNetwork": "ttrx:usdt",
      "payNetworkName": "Tron (TRC20)",
      "paymentMethod": "on_chain",
      "payoutFee": "0.120000",
      "payoutFeeCurrency": "USDT",
      "receiverBinanceId": null,
      "reference": "docs-webhook-invoice-1793795384",
      "status": "completed",
      "txid": "d42e4543e9b56aa46aa8fb686d9553ec24152291f7cacada8063bdda113aef35"
    },
    "id": "7c5841a1-470f-4a11-83dc-eb70d3d196f1",
    "relationships": {
      "accountCharged": {
        "data": {
          "id": "e289de2b-37bd-4eff-b832-f754c31a2d95",
          "type": "accounts"
        }
      },
      "author": {
        "data": {
          "id": "6038417d-7774-414c-9d81-d0c8ab1c3ed7",
          "type": "apiKeys"
        }
      }
    },
    "type": "payouts"
  },
  "included": [
    {
      "attributes": {
        "balance": "306064.429778",
        "bankDepositAvailable": false,
        "bankReference": "BDR4180381621673581",
        "bankWithdrawalAvailable": false,
        "currencyCode": "USDT",
        "currencyType": "crypto",
        "label": "master",
        "master": true,
        "totalBalance": null,
        "transferAvailable": true
      },
      "id": "e289de2b-37bd-4eff-b832-f754c31a2d95",
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        },
        "txnBankCredentials": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "accounts"
    },
    {
      "attributes": {
        "createdAt": "2026-11-03T17:57:41.705Z",
        "name": "CL"
      },
      "id": "6038417d-7774-414c-9d81-d0c8ab1c3ed7",
      "type": "apiKeys"
    }
  ],
  "meta": {}
}
```

{% endtab %}

{% tab title="Status Cancelled" %}

```json
{
  "data": {
    "id": "9ecba2f9-cc84-4c37-9d05-84570b72c816",
    "type": "payouts",
    "attributes": {
      "absorbFees": null,
      "absorbNetworkFee": true,
      "absorbPayoutFee": true,
      "address": "TTbGTMwUwA3mncLP7xqCZei1ekaNSgeAJe",
      "amount": "50.00",
      "amountCharged": "51.39",
      "amountChargedCurrency": "EUR",
      "approvalStatus": null,
      "binanceOrderId": null,
      "binanceStatus": null,
      "createdAt": "2026-05-15T19:00:00.000Z",
      "currency": "EUR",
      "displayFee": "0.50",
      "displayFeeCurrency": "EUR",
      "exchangeRate": "0.8866755",
      "expiresAt": "2026-05-15T19:00:30.000Z",
      "networkFee": "1.000000",
      "networkFeeCurrency": "USDT",
      "payAmount": "56.390416",
      "payChargeRate": "0.8866755",
      "payChargeRateCurrency": "EUR",
      "payCurrency": "USDT",
      "payNetwork": "ttrx:usdt",
      "payNetworkName": "Tron (TRC20)",
      "paymentMethod": "on_chain",
      "payoutFee": "0.50",
      "payoutFeeCurrency": "EUR",
      "receiverBinanceId": null,
      "reference": "9a3e4720-b2e4-e899-fcbb-b956a1b2c3d4",
      "status": "cancelled",
      "txid": null
    },
    "relationships": {
      "accountCharged": {
        "data": {
          "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
          "type": "accounts"
        }
      },
      "author": {
        "data": {
          "id": "3cd066e3-94f7-4182-a242-bf3b4e8ea2da",
          "type": "apiKeys"
        }
      }
    }
  },
  "included": [
    {
      "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
      "type": "accounts",
      "attributes": {
        "balance": "39207.72",
        "bankDepositAvailable": true,
        "bankReference": "BDR6421088115176062",
        "bankWithdrawalAvailable": true,
        "currencyCode": "EUR",
        "currencyType": "fiat",
        "label": "master",
        "master": true,
        "totalBalance": null,
        "transferAvailable": true
      },
      "relationships": {
        "company": { "meta": { "included": false } },
        "networks": { "meta": { "included": false } },
        "txnBankCredentials": { "meta": { "included": false } }
      }
    },
    {
      "id": "3cd066e3-94f7-4182-a242-bf3b4e8ea2da",
      "type": "apiKeys",
      "attributes": {
        "createdAt": "2026-05-07T10:39:48.046Z",
        "name": "My API Key"
      }
    }
  ],
  "meta": {}
}
```

{% endtab %}
{% endtabs %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.txn.io/payouts/payout-webhooks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
