> 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/reading-bank-deposit.md).

# Reading bank deposit

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

Returns one bank deposit: its `amount` and `simplifiedState`, explained in [Bank deposit status flow](https://docs.txn.io/fiat-settlements/bank-deposit-status-flow.md), with the account it was credited to and the transfer details in `included[]`.

**Headers**

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

**Path Parameters**

| Name | Value            |
| ---- | ---------------- |
| id   | Bank deposit ID. |

**cURL**

```bash
curl "https://api.sandbox.txn.io/api/public/v1/transactions/bank_deposits/e3179a9a-8813-4e2e-9fa4-7de54192a7f1" \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer <api_key>'
```

**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 deposit 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>Deposit status. One of <code>pending</code>, <code>on_hold</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>BankDepositTransaction</code>.</td></tr><tr><td>data.attributes.amount</td><td>string</td><td>Amount credited to the account.</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 deposit reference.</td></tr><tr><td>data.attributes.accountId</td><td>string</td><td>ID of the account the deposit was credited to.</td></tr><tr><td>data.relationships.transactionDetails</td><td>object</td><td>The bank deposit record. <code>data.type</code> is <code>bankDepositTransactions</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(bankDepositTransactions)</td><td>object</td><td>The transfer as received from the bank. Its <code>id</code> equals <code>data.id</code>.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.amount</td><td>string</td><td>Amount credited, in <code>currency</code>. Same as <code>data.attributes.amount</code>.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.currency</td><td>string</td><td>Currency of the transfer. Equals the account currency and <code>data.attributes.currency</code>.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.reference</td><td>string</td><td>The payment reference the payer quoted, which is how the transfer was matched to your account: its <code>bankReference</code>. Same as <code>data.attributes.reference</code>.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.payerName</td><td>string</td><td>Name of the payer, as reported by the bank. <code>null</code> when the bank does not provide it.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.payerIban</td><td>string</td><td>IBAN the transfer came from. <code>null</code> when the bank does not provide it.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.payerBic</td><td>string</td><td>BIC/SWIFT code of the payer's bank. <code>null</code> when the bank does not provide it.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.payerAddress</td><td>string</td><td>Address of the payer. <code>null</code> when the bank does not provide it.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.simplifiedState</td><td>string</td><td>Deposit status. Same value as <code>data.attributes.simplifiedState</code>; see <a href="https://docs.txn.io/fiat-settlements/bank-deposit-status-flow.md">Bank deposit status flow</a>.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.state</td><td>string</td><td>Internal Txn state. Ignore this field and use <code>simplifiedState</code>.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.createdAt</td><td>string</td><td>When Txn recorded the transfer.</td></tr><tr><td>included[].type(bankDepositTransactions).attributes.updatedAt</td><td>string</td><td>When the deposit last changed.</td></tr><tr><td>included[].type(bankDepositTransactions).relationships.account</td><td>object</td><td>The account credited. <code>data.type</code> is <code>accounts</code>; the entity is returned in <code>included[]</code>.</td></tr><tr><td>included[].type(bankDepositTransactions).relationships.author</td><td>object</td><td>Not expanded (<code>meta.included</code> is <code>false</code>).</td></tr><tr><td>included[].type(accounts)</td><td>object</td><td>The account the deposit was credited to (<code>included[].type(bankDepositTransactions).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></tbody></table>

**Response**

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

```json
{
  "data": {
    "id": "e3179a9a-8813-4e2e-9fa4-7de54192a7f1",
    "type": "transactions",
    "attributes": {
      "createdAt": "2026-10-14T08:48:58.291Z",
      "simplifiedState": "completed",
      "transactionType": "BankDepositTransaction",
      "amount": "0.99",
      "currency": "EUR",
      "balance": null,
      "reference": "BDR5037483372623258",
      "accountId": "0534d6fe-6c31-4b98-a21d-686c2aa1d872"
    },
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "transactionDetails": {
        "data": {
          "type": "bankDepositTransactions",
          "id": "e3179a9a-8813-4e2e-9fa4-7de54192a7f1"
        }
      },
      "author": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "included": [
    {
      "id": "e3179a9a-8813-4e2e-9fa4-7de54192a7f1",
      "type": "bankDepositTransactions",
      "attributes": {
        "createdAt": "2026-10-14T08:48:58.261Z",
        "updatedAt": "2026-10-14T08:48:58.261Z",
        "state": "completed",
        "payerName": null,
        "payerIban": null,
        "payerAddress": null,
        "payerBic": null,
        "reference": "BDR5037483372623258",
        "currency": "EUR",
        "amount": "0.99",
        "simplifiedState": "completed"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "accounts",
            "id": "0534d6fe-6c31-4b98-a21d-686c2aa1d872"
          }
        },
        "author": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "0534d6fe-6c31-4b98-a21d-686c2aa1d872",
      "type": "accounts",
      "attributes": {
        "master": false,
        "currencyCode": "EUR",
        "label": "90",
        "bankReference": "BDR5037483372623258",
        "balance": "2.98",
        "totalBalance": null,
        "bankWithdrawalAvailable": true,
        "bankDepositAvailable": true,
        "transferAvailable": true,
        "currencyType": "fiat"
      },
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        },
        "txnBankCredentials": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {},
  "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/reading-bank-deposit.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.
