> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bleepay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Query Deposit Sessions

> List deposit sessions for a business.

`GET /api/v1/widgets/deposit-sessions`

Returns a paginated list of deposit sessions belonging to the authenticated business. You can filter by time range, payment status, network, currency, and widget.

## Parameters

### Query

| Name            | Type      | Required | Description                                                                                                                                                                          |
| --------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `businessId`    | `string`  | Yes      | The business ID                                                                                                                                                                      |
| `widgetId`      | `string`  | No       | Filter by widget ID                                                                                                                                                                  |
| `paymentStatus` | `string`  | No       | Filter by payment status: `CREATED`, `PENDING`, `CONFIRMED`, `EXPIRED`, `FAILED`, `UNDERPAID`, `OVERPAID`, `REFUNDED`. When not provided, `CREATED` sessions are excluded by default |
| `status`        | `string`  | No       | Filter by session status: `PENDING`, `ENABLED`, `DISABLED`, `SUSPENDED`                                                                                                              |
| `network`       | `string`  | No       | Filter by blockchain network (e.g. `polygon`)                                                                                                                                        |
| `currency`      | `string`  | No       | Filter by currency symbol (e.g. `USDC`)                                                                                                                                              |
| `limit`         | `integer` | No       | Number of items (default 20, max 100)                                                                                                                                                |
| `offset`        | `integer` | No       | Pagination offset                                                                                                                                                                    |
| `since`         | `integer` | No       | Unix timestamp (ms) -- return items created after this time                                                                                                                          |
| `until`         | `integer` | No       | Unix timestamp (ms) -- return items created before this time                                                                                                                         |

## Request example

```shell theme={null}
curl --request GET 'https://payments.bleepay.com/api/v1/widgets/deposit-sessions?businessId=biz_abc123&paymentStatus=CONFIRMED&limit=20' \
  --header 'Authorization: Bearer <business_token>'
```

## Response

### Response schema

| Field                   | Type               | Description                                                                                         |
| ----------------------- | ------------------ | --------------------------------------------------------------------------------------------------- |
| `id`                    | `string`           | Unique session identifier                                                                           |
| `businessId`            | `string`           | The business ID                                                                                     |
| `widgetId`              | `string`           | The widget ID                                                                                       |
| `paymentStatus`         | `string`           | Status: `CREATED`, `PENDING`, `CONFIRMED`, `EXPIRED`, `FAILED`, `UNDERPAID`, `OVERPAID`, `REFUNDED` |
| `amount`                | `string`           | Payment amount                                                                                      |
| `amountRaw`             | `string`           | Raw amount in lowest denominator                                                                    |
| `currency`              | `string`           | Currency symbol                                                                                     |
| `network`               | `string`           | Blockchain network                                                                                  |
| `currencyAddress`       | `string`           | Currency contract address                                                                           |
| `depositAddress`        | `string`           | Destination address                                                                                 |
| `value`                 | `string`           | Estimated USD value                                                                                 |
| `valueRaw`              | `string`           | Raw USD value in lowest denominator                                                                 |
| `confirmedTxid`         | `string` or `null` | Confirmed blockchain transaction hash                                                               |
| `confirmedPayerAddress` | `string` or `null` | Confirmed payer wallet address                                                                      |
| `customerEmail`         | `string` or `null` | Customer's email                                                                                    |
| `customerReference`     | `string` or `null` | Your internal reference ID                                                                          |
| `expiresAt`             | `string`           | ISO 8601 expiry timestamp                                                                           |
| `confirmedAt`           | `string` or `null` | ISO 8601 confirmation timestamp                                                                     |
| `createdAt`             | `string`           | ISO 8601 creation timestamp                                                                         |
| `updatedAt`             | `string`           | ISO 8601 last update timestamp                                                                      |

### Example response

```json theme={null}
[
  {
    "id": "dep_a1b2c3d4e5f6",
    "businessId": "biz_abc123",
    "widgetId": "wdgt_abc",
    "paymentStatus": "CONFIRMED",
    "amount": "100",
    "amountRaw": "100000000",
    "currency": "USDC",
    "network": "polygon",
    "currencyAddress": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
    "depositAddress": "0xMerchantWalletAddress",
    "value": "100.00",
    "valueRaw": "10000",
    "confirmedTxid": "0xabc123def456...",
    "confirmedPayerAddress": "0xPayerWallet123...",
    "customerEmail": "customer@example.com",
    "customerReference": "order_12345",
    "expiresAt": "2026-06-09T12:30:00.000Z",
    "confirmedAt": "2026-06-09T12:05:00.000Z",
    "createdAt": "2026-06-09T12:00:00.000Z",
    "updatedAt": "2026-06-09T12:05:00.000Z"
  }
]
```

### Error responses

| Status | Code                | Description                       |
| ------ | ------------------- | --------------------------------- |
| `401`  | `unauthorized`      | Missing or invalid authentication |
| `400`  | `validation_failed` | Invalid query parameters          |