---
# @generated by sylphx-gen. Do not edit.
title: "List bank receipts"
description: "`money.bank_receipts.list` (GET /v1/{parent}/bank_receipts): Lists incoming bank evidence, including receipts held for review."
type: reference
product: payments
summary: "Lists incoming bank evidence, including receipts held for review."
updated: 2026-09-28
nav: false
---

Lists incoming bank evidence, including receipts held for review.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts`
- **Scope** `billing:bank_receipts:read`
- **Effect** `read` — nothing is written.
- **Collection** [bank_receipts](/docs/api/bank_receipts)
- **Query** `page_size`, `page_token`, `filter`
- **Pagination** the answer carries `bank_receipts` and, when there is more, `next_page_token`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | Environment resource name. Required. |
| `page_size` | `int32` | Default 50, at most 1000. |
| `page_token` | `string` | Token from the preceding page. |
| `filter` | `string` | Optional state equality: held, paid, rejected, refunded or reversed. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `bank_receipts` | `BankReceipt[]` | Receipts ordered by creation time and id. |
| `next_page_token` | `string` | Empty on the last page. |

### BankReceipt

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Resource name. |
| `uid` | `string` | Stable resource identity. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. Output only. |
| `checkout_session` | `string` | The checkout this receipt was submitted against. Output only. |
| `bank_transaction_id` | `string` | The bank statement transaction identity. Output only. |
| `amount_minor` | `int64` | Amount actually received in minor units. Output only. |
| `currency_code` | `string` | Currency actually received. Output only. |
| `received_time` | `timestamp` | Bank-reported receipt time. Output only. |
| `reference` | `string` | Reference observed on the bank statement; empty is held. Output only. |
| `payer_evidence` | `string` | Evidence locator or statement evidence; screenshots alone are not proof. Output only. |
| `confirmer` | `string` | Authenticated principal that recorded this receipt. Output only. |
| `state` | `string` | paid, held, rejected, refunded or reversed. Output only. |
| `hold_reason` | `string` | Why settlement was held. Output only. |
| `entries` | `BankReceiptEntry[]` | Append-only human resolution, refund and reversal history. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### BankReceiptEntry

| Field | Type | What it is |
| --- | --- | --- |
| `kind` | `string` | accept, reject, refund or reversal. Output only. |
| `evidence` | `string` | Operator evidence supporting this decision. Output only. |
| `confirmer` | `string` | Authenticated decision maker. Output only. |
| `create_time` | `timestamp` | UTC decision time. Output only. |
| `external_reference` | `string` | Bank refund/reversal reference, when applicable. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`PAGE_TOKEN_MISMATCH`](/docs/api/errors/PAGE_TOKEN_MISMATCH) — A page token was reused with different parameters.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_receipts" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.money.bankReceipts.list({ parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::money::ListBankReceiptsRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.money().bank_receipts().list(req).await?;
```

**CLI**

```bash
sylphx money bank-receipts list orgs/acme/projects/shop/envs/production
```

**MCP**

```json
{ "method_id": "money.bank_receipts.list", "args": {"parent":"orgs/acme/projects/shop/envs/production"} }
```