> 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/fiat-settlements/listing-bank-withdrawals.md).

# Listing bank withdrawals

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

Returns your bank withdrawals with pagination. Filter by `created_at_from` and `created_at_to`. `simplifiedState` follows the [Bank withdrawal status flow](https://docs.txn.io/fiat-settlements/bank-withdrawal-status-flow.md). The bank account paid, the `payAmount` sent and the `fee` are in `included[]` under `transactionDetails`.

**Headers**

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

**URL Parameters**

<table><thead><tr><th width="166.71502685546875">Name</th><th width="130.13836669921875">Type</th><th>Description</th></tr></thead><tbody><tr><td>order</td><td>string</td><td>Order in which the list of transactions should be returned. Can be <code>created_at</code>.</td></tr><tr><td>order_type</td><td>string</td><td>Order type. Can be either <code>asc</code> or <code>desc</code>.</td></tr><tr><td>page</td><td>number</td><td>Page for which you want to return transactions.</td></tr><tr><td>per_page</td><td>number</td><td>Number of transactions per page to return.</td></tr><tr><td>created_at_from</td><td>string</td><td>Return bank withdrawals 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 bank withdrawals 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/transactions/bank_withdrawals" \
     -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="97">Type</th><th>Description</th></tr></thead><tbody><tr><td>data[].id</td><td>string</td><td>Transaction ID.</td></tr><tr><td>data[].type</td><td>string</td><td>Entity type returned. Always <code>transactions</code>.</td></tr><tr><td>data[].attributes</td><td>object</td><td>Set of transaction attributes.</td></tr><tr><td>data[].attributes.createdAt</td><td>string</td><td>Timestamp when the withdrawal was created. Refer to the <a href="https://docs.txn.io/api-basics/date-and-time-format.md">Date and time format</a> page.</td></tr><tr><td>data[].attributes.simplifiedState</td><td>string</td><td>Withdrawal status. One of <code>pending</code>, <code>send_failed</code>, <code>completed</code>, <code>cancelled</code>. See <a href="https://docs.txn.io/transactions/listing-transactions.md#transaction-statuses">Transaction statuses</a>.</td></tr><tr><td>data[].attributes.transactionType</td><td>string</td><td>Transaction type. Always <code>BankWithdrawalTransaction</code>.</td></tr><tr><td>data[].attributes.amount</td><td>string</td><td>Amount debited from the account. Negative for withdrawals.</td></tr><tr><td>data[].attributes.currency</td><td>string</td><td>Currency code of the transaction.</td></tr><tr><td>data[].attributes.balance</td><td>string</td><td>Account balance immediately after Txn processed this transaction. <code>null</code> when not applicable.</td></tr><tr><td>data[].attributes.reference</td><td>string</td><td>Bank withdrawal reference.</td></tr><tr><td>data[].attributes.accountId</td><td>string</td><td>ID of the account the withdrawal was debited from.</td></tr><tr><td>data[].relationships.transactionDetails</td><td>object</td><td>The bank withdrawal record. <code>data.type</code> is <code>bankWithdrawalTransactions</code> and <code>data.id</code> is the transaction's own ID; the entity is returned in <code>included[]</code>.</td></tr><tr><td>data[].relationships.account</td><td>object</td><td>Not expanded (<code>meta.included</code> is <code>false</code>). Use <code>data[].attributes.accountId</code>, or the <code>accounts</code> entity in <code>included[]</code>.</td></tr><tr><td>data[].relationships.author</td><td>object</td><td>Not expanded (<code>meta.included</code> is <code>false</code>).</td></tr><tr><td>included[].type(bankWithdrawalTransactions)</td><td>object</td><td>The withdrawal record: what was sent to the bank, the fee, and the bank-side status. Its <code>id</code> equals <code>data[].id</code>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.amount</td><td>string</td><td>Total debited from your account, in <code>currency</code>: <code>payAmount</code> plus <code>fee</code>. Positive here; <code>data[].attributes.amount</code> carries the same value negated.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.payAmount</td><td>string</td><td>Amount sent to the bank account. Equals the amount you requested when <code>absorbFees</code> is <code>true</code>, and the requested amount minus <code>fee</code> when it is <code>false</code>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.fee</td><td>string</td><td>Txn fee for the withdrawal, in <code>currency</code>, as configured for the bank account.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.absorbFees</td><td>boolean</td><td><code>true</code>: the fee is charged on top and the beneficiary receives the full requested amount. <code>false</code>: the fee is deducted from the amount sent.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.currency</td><td>string</td><td>Currency of the bank account and of every amount in this entity. Equals <code>data[].attributes.currency</code>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.reference</td><td>string</td><td>The reference you set at creation. Same as <code>data[].attributes.reference</code>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.beneficiaryName</td><td>string</td><td>Beneficiary name of the bank account paid.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.iban</td><td>string</td><td>IBAN of the bank account paid.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.bankBic</td><td>string</td><td>BIC/SWIFT code of the beneficiary's bank. <code>null</code> when not registered on the bank account.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.bankName</td><td>string</td><td>Name of the beneficiary's bank. <code>null</code> when not registered on the bank account.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.simplifiedState</td><td>string</td><td>Withdrawal status. Same value as <code>data[].attributes.simplifiedState</code>; see <a href="https://docs.txn.io/fiat-settlements/bank-withdrawal-status-flow.md">Bank withdrawal status flow</a>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.state</td><td>string</td><td>Same value as <code>simplifiedState</code>, kept for compatibility.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.paymentStatus</td><td>string</td><td>Processing status on the bank side. See <a href="https://docs.txn.io/fiat-settlements/bank-withdrawal-status-flow.md#bank-side-processing-status">Bank-side processing status</a>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.approvalStatus</td><td>string</td><td>Approval-workflow status when an approval rule applied to the withdrawal: <code>requested</code>, <code>approved</code>, <code>rejected</code> or <code>cancelled</code>. <code>null</code> when no approval was required. See <a href="https://docs.txn.io/fiat-settlements/bank-withdrawal-status-flow.md#bank-side-processing-status">Bank-side processing status</a>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.createdAt</td><td>string</td><td>When the withdrawal was created.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).attributes.updatedAt</td><td>string</td><td>When the withdrawal last changed.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).relationships.bankAccount</td><td>object</td><td>The bank account paid. <code>data.type</code> is <code>bankAccounts</code>; the entity is returned in <code>included[]</code>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).relationships.account</td><td>object</td><td>The account debited. <code>data.type</code> is <code>accounts</code>; the entity is returned in <code>included[]</code>.</td></tr><tr><td>included[].type(bankWithdrawalTransactions).relationships.author</td><td>object</td><td>Not expanded (<code>meta.included</code> is <code>false</code>).</td></tr><tr><td>included[].type(bankAccounts)</td><td>object</td><td>The bank account the funds were sent to, as returned by <a href="https://docs.txn.io/fiat-settlements/reading-bank-account.md">Reading bank account</a>.</td></tr><tr><td>included[].type(bankAccounts).attributes.label</td><td>string</td><td>User-defined label for the bank account.</td></tr><tr><td>included[].type(bankAccounts).attributes.beneficiaryName</td><td>string</td><td>Name of the beneficiary on the bank account.</td></tr><tr><td>included[].type(bankAccounts).attributes.iban</td><td>string</td><td>Beneficiary IBAN.</td></tr><tr><td>included[].type(bankAccounts).attributes.bankBic</td><td>string</td><td>BIC/SWIFT code of the beneficiary's bank.</td></tr><tr><td>included[].type(bankAccounts).attributes.bankName</td><td>string</td><td>Name of the beneficiary's bank.</td></tr><tr><td>included[].type(bankAccounts).attributes.currencyCode</td><td>string</td><td>Account currency code. Refer to <a href="https://docs.txn.io/api-basics/supported-currencies.md">supported currencies</a>.</td></tr><tr><td>included[].type(bankAccounts).attributes.createdAt</td><td>string</td><td>Timestamp when the bank account was created. Refer to the <a href="https://docs.txn.io/api-basics/date-and-time-format.md">Date and time format</a> page.</td></tr><tr><td>included[].type(bankAccounts).attributes.updatedAt</td><td>string</td><td>Timestamp when the bank account was last updated.</td></tr><tr><td>included[].type(accounts)</td><td>object</td><td>The account the withdrawal was debited from (<code>included[].type(bankWithdrawalTransactions).relationships.account</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.currency</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.bankReference</td><td>string</td><td>The bank deposit reference of the account.</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>Always <code>fiat</code> here.</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>meta.page</td><td>number</td><td>Current page number.</td></tr><tr><td>meta.per_page</td><td>number</td><td>Page size used for the response.</td></tr><tr><td>meta.total</td><td>number</td><td>Total number of withdrawals matching the query.</td></tr></tbody></table>

**Response**

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

```json
{
  "data": [
    {
      "id": "22b9bcb8-2127-4a29-8398-b632c3c127f7",
      "type": "transactions",
      "attributes": {
        "createdAt": "2026-10-28T12:21:34.828Z",
        "simplifiedState": "completed",
        "transactionType": "BankWithdrawalTransaction",
        "amount": "-1.01",
        "currency": "EUR",
        "balance": null,
        "reference": "Fiat payout from Txn to Acme",
        "accountId": "13a85b45-8543-41c7-b963-394d4ea128ae"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "transactionDetails": {
          "data": {
            "type": "bankWithdrawalTransactions",
            "id": "22b9bcb8-2127-4a29-8398-b632c3c127f7"
          }
        },
        "author": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2ccae6e6-6936-4141-9522-edb73202529d",
      "type": "transactions",
      "attributes": {
        "createdAt": "2026-10-28T12:20:39.990Z",
        "simplifiedState": "completed",
        "transactionType": "BankWithdrawalTransaction",
        "amount": "-1.00",
        "currency": "EUR",
        "balance": null,
        "reference": "Fiat payout from Txn to Acme",
        "accountId": "13a85b45-8543-41c7-b963-394d4ea128ae"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "transactionDetails": {
          "data": {
            "type": "bankWithdrawalTransactions",
            "id": "2ccae6e6-6936-4141-9522-edb73202529d"
          }
        },
        "author": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "22b9bcb8-2127-4a29-8398-b632c3c127f7",
      "type": "bankWithdrawalTransactions",
      "attributes": {
        "absorbFees": true,
        "createdAt": "2026-10-28T12:21:34.824Z",
        "updatedAt": "2026-10-28T12:28:36.747Z",
        "iban": "LT483750000000000007",
        "beneficiaryName": "Acme",
        "reference": "Fiat payout from Txn to Acme",
        "paymentStatus": "completed",
        "bankBic": null,
        "bankName": null,
        "approvalStatus": "approved",
        "currency": "EUR",
        "amount": "1.01",
        "payAmount": "1.00",
        "fee": "0.01",
        "state": "completed",
        "simplifiedState": "completed"
      },
      "relationships": {
        "bankAccount": {
          "data": {
            "type": "bankAccounts",
            "id": "1368a1d7-6b5e-4c89-b525-5c3bc73c0882"
          }
        },
        "account": {
          "data": {
            "type": "accounts",
            "id": "13a85b45-8543-41c7-b963-394d4ea128ae"
          }
        },
        "author": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2ccae6e6-6936-4141-9522-edb73202529d",
      "type": "bankWithdrawalTransactions",
      "attributes": {
        "absorbFees": false,
        "createdAt": "2026-10-28T12:20:39.982Z",
        "updatedAt": "2026-10-28T12:20:53.020Z",
        "iban": "LT483750000000000007",
        "beneficiaryName": "Acme",
        "reference": "Fiat payout from Txn to Acme",
        "paymentStatus": "completed",
        "bankBic": null,
        "bankName": null,
        "approvalStatus": null,
        "currency": "EUR",
        "amount": "1.00",
        "payAmount": "0.99",
        "fee": "0.01",
        "state": "completed",
        "simplifiedState": "completed"
      },
      "relationships": {
        "bankAccount": {
          "data": {
            "type": "bankAccounts",
            "id": "1368a1d7-6b5e-4c89-b525-5c3bc73c0882"
          }
        },
        "account": {
          "data": {
            "type": "accounts",
            "id": "13a85b45-8543-41c7-b963-394d4ea128ae"
          }
        },
        "author": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1368a1d7-6b5e-4c89-b525-5c3bc73c0882",
      "type": "bankAccounts",
      "attributes": {
        "beneficiaryName": "Acme",
        "currencyCode": "EUR",
        "iban": "LT483750000000000007",
        "createdAt": "2026-08-03T10:49:30.676Z",
        "updatedAt": "2026-08-10T08:59:42.027Z",
        "bankBic": null,
        "bankName": null,
        "label": "Acme EUR 2"
      }
    },
    {
      "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
      "type": "accounts",
      "attributes": {
        "master": true,
        "currencyCode": "EUR",
        "label": "master",
        "bankReference": "BDR6421088115176062",
        "balance": "39161.07",
        "totalBalance": null,
        "bankWithdrawalAvailable": true,
        "bankDepositAvailable": true,
        "transferAvailable": true,
        "currencyType": "fiat"
      },
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        },
        "txnBankCredentials": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3
  },
  "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/fiat-settlements/listing-bank-withdrawals.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.
