> 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/listing-payouts.md).

# Listing payouts

<mark style="color:green;">`GET`</mark> `/api/public/v1/payouts`

Returns your payouts, newest first by default, with pagination. Filter by `reference` to find a payout you created, or by `created_at_from` and `created_at_to` to reconcile a period. Each entry carries the same attributes as [Reading payout](https://docs.txn.io/payouts/reading-payout.md), including `status` and `txid`. Drafts that were never confirmed are not listed.

**Headers**

| Name          | Value                      |
| ------------- | -------------------------- |
| Content-Type  | `application/vnd.api+json` |
| Authorization | `Bearer <api_key>`         |

**URL Parameters**

<table><thead><tr><th width="160.5435791015625">Name</th><th width="128">Type</th><th>Description</th></tr></thead><tbody><tr><td>order</td><td>string</td><td>Field to sort by. Supported value: <code>created_at</code>.</td></tr><tr><td>order_type</td><td>string</td><td>Sort direction. <code>asc</code> or <code>desc</code>.</td></tr><tr><td>page</td><td>number</td><td>Page number to return.</td></tr><tr><td>per_page</td><td>number</td><td>Number of results per page.</td></tr><tr><td>reference</td><td>string</td><td>Filter by payout <code>reference</code>.</td></tr><tr><td>created_at_from</td><td>string</td><td>Return payouts created at or after this ISO 8601 timestamp, e.g. <code>2024-06-18T15:49:02.031Z</code>.</td></tr><tr><td>created_at_to</td><td>string</td><td>Return payouts created at or before this ISO 8601 timestamp, e.g. <code>2024-06-18T15:49:02.031Z</code>.</td></tr></tbody></table>

**cURL**

```bash
curl -G "https://api.sandbox.txn.io/api/public/v1/payouts" \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer <api_key>' \
     --data-urlencode 'created_at_from=2026-10-01T00:00:00Z' \
     --data-urlencode 'created_at_to=2026-11-01T00:00:00Z' \
     --data-urlencode 'per_page=100' \
     --data-urlencode 'page=1'
```

**Response Body**

<table><thead><tr><th>Name</th><th width="96">Type</th><th>Description</th></tr></thead><tbody><tr><td>data[].id</td><td>string</td><td>Payout ID.</td></tr><tr><td>data[].type</td><td>string</td><td>Always <code>payouts</code>.</td></tr><tr><td>data[].attributes.reference</td><td>string</td><td>Your internal correlation key, as set at creation.</td></tr><tr><td>data[].attributes.status</td><td>string</td><td>Payout status. Refer to <a href="https://docs.txn.io/payouts/payout-status-flow.md">Payout Status Flow</a>.</td></tr><tr><td>data[].attributes.address</td><td>string</td><td>Recipient's wallet address.</td></tr><tr><td>data[].attributes.createdAt</td><td>string</td><td>ISO 8601 timestamp of when the payout was created.</td></tr><tr><td>data[].attributes.expiresAt</td><td>string</td><td>ISO 8601 timestamp of when the exchange rate lock expires.</td></tr><tr><td>data[].attributes.absorbFees</td><td>boolean</td><td>Deprecated. Use <code>absorbPayoutFee</code> and <code>absorbNetworkFee</code> instead.</td></tr><tr><td>data[].attributes.absorbPayoutFee</td><td>boolean</td><td>If <code>false</code>, the payout fee was deducted from the amount the recipient received. If <code>true</code>, the fee was charged to your account balance.</td></tr><tr><td>data[].attributes.absorbNetworkFee</td><td>boolean</td><td>If <code>false</code>, the network fee was deducted from the amount the recipient received. If <code>true</code>, the fee was charged to your account balance.</td></tr><tr><td>data[].attributes.amount</td><td>number</td><td>Payout amount in <code>currency</code>.</td></tr><tr><td>data[].attributes.currency</td><td>string</td><td>Payout amount currency code.</td></tr><tr><td>data[].attributes.payCurrency</td><td>string</td><td>Currency code of the cryptocurrency sent to the recipient.</td></tr><tr><td>data[].attributes.payAmount</td><td>string</td><td>Amount of cryptocurrency sent to the recipient.</td></tr><tr><td>data[].attributes.txid</td><td>string</td><td>On-chain transaction hash. <code>null</code> until the transaction is broadcast.</td></tr><tr><td>data[].attributes.payNetwork</td><td>string</td><td>Network code of the cryptocurrency sent. See <a href="https://docs.txn.io/api-basics/supported-currencies.md">Supported Currencies</a>.</td></tr><tr><td>data[].attributes.payNetworkName</td><td>string</td><td>Human-readable network name, e.g. <code>Tron (TRC20)</code>.</td></tr><tr><td>data[].attributes.networkFee</td><td>string</td><td>Network fee amount in <code>networkFeeCurrency</code>.</td></tr><tr><td>data[].attributes.networkFeeCurrency</td><td>string</td><td>Currency of the network fee.</td></tr><tr><td>data[].attributes.payoutFee</td><td>string</td><td>Txn service fee amount in <code>payoutFeeCurrency</code>.</td></tr><tr><td>data[].attributes.payoutFeeCurrency</td><td>string</td><td>Currency of the Txn service fee.</td></tr><tr><td>data[].attributes.displayFee</td><td>string</td><td>Payout fee expressed in <code>currency</code>.</td></tr><tr><td>data[].attributes.displayFeeCurrency</td><td>string</td><td>Currency of <code>displayFee</code>. Always matches <code>currency</code>.</td></tr><tr><td>data[].attributes.amountCharged</td><td>string</td><td>Total amount debited from your account, including all fees, in <code>amountChargedCurrency</code>.</td></tr><tr><td>data[].attributes.amountChargedCurrency</td><td>string</td><td>Currency of <code>amountCharged</code>. Matches <code>chargeCurrency</code>.</td></tr><tr><td>data[].attributes.payChargeRate</td><td>string</td><td>Exchange rate between <code>payCurrency</code> and <code>amountChargedCurrency</code> applied by Txn.</td></tr><tr><td>data[].attributes.payChargeRateCurrency</td><td>string</td><td>Quote currency of <code>payChargeRate</code>.</td></tr><tr><td>data[].attributes.exchangeRate</td><td>string</td><td>Exchange rate between <code>payCurrency</code> and <code>currency</code> applied by Txn.</td></tr><tr><td>data[].attributes.paymentMethod</td><td>string</td><td>Payment method used: <code>on_chain</code> or <code>binance_pay</code>.</td></tr><tr><td>data[].attributes.receiverBinanceId</td><td>string</td><td>Recipient's Binance ID. Present only for <code>binance_pay</code> payouts.</td></tr><tr><td>data[].attributes.approvalStatus</td><td>string</td><td>Approval workflow status. <code>null</code> for API-created payouts. See <a href="https://docs.txn.io/payouts/payout-status-flow.md">Payout Status Flow</a>.</td></tr><tr><td>data[].attributes.binanceStatus</td><td>string</td><td>Binance Pay processing status. Present only for <code>binance_pay</code> payouts.</td></tr><tr><td>data[].attributes.binanceOrderId</td><td>string</td><td>Order ID that Binance assigns to the transfer. It is the number the recipient sees as <strong>Order ID</strong> in their Binance app. <code>null</code> until Txn receives it from Binance, which can be some time after the payout's <code>status</code> changes to <code>completed</code>. Always <code>null</code> for <code>on_chain</code> payouts.</td></tr><tr><td>data[].relationships.accountCharged</td><td>object</td><td>The account the payout was debited from. <code>data.type</code> is <code>accounts</code>; the entity is returned in <code>included[]</code>. Its currency is <code>data[].attributes.amountChargedCurrency</code>.</td></tr><tr><td>data[].relationships.author</td><td>object</td><td>The API key that created the payout. <code>data.type</code> is <code>apiKeys</code>; the entity is returned in <code>included[]</code>. <code>data</code> is <code>null</code> when the payout was created in the dashboard, including mass payouts.</td></tr><tr><td>included[].type(accounts)</td><td>object</td><td>The account the payout was debited from (<code>data[].relationships.accountCharged</code>). Same fields as <a href="https://docs.txn.io/accounts/reading-account.md">Reading account</a>; the ones most relevant here are listed below.</td></tr><tr><td>included[].type(accounts).attributes.currencyCode</td><td>string</td><td>Account currency. Equals <code>data[].attributes.amountChargedCurrency</code>.</td></tr><tr><td>included[].type(accounts).attributes.label</td><td>string</td><td>Account label.</td></tr><tr><td>included[].type(accounts).attributes.master</td><td>boolean</td><td><code>true</code> for the master account, <code>false</code> for a subaccount.</td></tr><tr><td>included[].type(accounts).attributes.balance</td><td>string</td><td>Account balance at the time of the request.</td></tr><tr><td>included[].type(accounts).attributes.currencyType</td><td>string</td><td><code>fiat</code> or <code>crypto</code>.</td></tr><tr><td>included[].type(accounts).relationships</td><td>object</td><td><code>company</code>, <code>networks</code> and <code>txnBankCredentials</code>: not expanded (<code>meta.included</code> is <code>false</code>).</td></tr><tr><td>included[].type(apiKeys)</td><td>object</td><td>The API key that created the payout (<code>data[].relationships.author</code>). Absent when <code>author</code> is <code>null</code>.</td></tr><tr><td>included[].type(apiKeys).attributes.name</td><td>string</td><td>Name of the API key, as set when it was created.</td></tr><tr><td>included[].type(apiKeys).attributes.createdAt</td><td>string</td><td>When the API key was created.</td></tr><tr><td>meta.page</td><td>number</td><td>Current page number.</td></tr><tr><td>meta.per_page</td><td>number</td><td>Number of results per page.</td></tr><tr><td>meta.total</td><td>number</td><td>Total number of payouts matching the query.</td></tr></tbody></table>

**Response**

{% tabs %}
{% tab title="HTTP 200" %}

```json
{
  "data": [
    {
      "id": "9d12fe2c-c8ac-44c7-b2f0-b9d11aa62f53",
      "type": "payouts",
      "attributes": {
        "absorbFees": null,
        "absorbNetworkFee": true,
        "absorbPayoutFee": true,
        "address": "TTbGTMwUwA3mncLP7xqCZei1ekaNSgeAJe",
        "amount": "500.00",
        "amountCharged": "64.84",
        "amountChargedCurrency": "EUR",
        "approvalStatus": null,
        "binanceOrderId": null,
        "binanceStatus": null,
        "createdAt": "2026-05-19T15:40:37.788Z",
        "currency": "CNY",
        "displayFee": "5.00",
        "displayFeeCurrency": "CNY",
        "exchangeRate": "7.01285182",
        "expiresAt": "2026-05-19T15:41:07.788Z",
        "networkFee": "1.000000",
        "networkFeeCurrency": "USDT",
        "payAmount": "71.297671",
        "payChargeRate": "0.8881381",
        "payChargeRateCurrency": "EUR",
        "payCurrency": "USDT",
        "paymentMethod": "on_chain",
        "payNetwork": "ttrx:usdt",
        "payNetworkName": "Tron (TRC20)",
        "payoutFee": "0.63",
        "payoutFeeCurrency": "EUR",
        "receiverBinanceId": null,
        "reference": "docs-cny-eur-example-001",
        "status": "completed",
        "txid": "c94f1a2b3d4e5f6071829384a5b6c7d8e9f0a1b2c3d4e5f607182938a4b5c6d7"
      },
      "relationships": {
        "accountCharged": {
          "data": {
            "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
            "type": "accounts"
          }
        },
        "author": {
          "data": {
            "id": "b56961f4-46cf-4e60-bb32-b36addb09f66",
            "type": "apiKeys"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
      "type": "accounts",
      "attributes": {
        "balance": "38904.08",
        "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": "b56961f4-46cf-4e60-bb32-b36addb09f66",
      "type": "apiKeys",
      "attributes": {
        "createdAt": "2024-06-17T19:41:33.398Z",
        "name": "Test API key"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total": 2766
  },
  "jsonapi": {
    "version": "1.0"
  }
}
```

{% 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/listing-payouts.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.
