# List Omnibus Transfers

The omnibus's sweeps and pool withdrawals on a network, newest first.

## Overview

- **Filters**: `kind` (`sweep` or `withdrawal`), `status`, and `accountId` — a customer's collection account, or the pool account that paid. Up to `limit` (1–200, default 50); `nextCursor` to send as `cursor` for the next page — `null` on the last. A cursor the route did not give answers `400` `STRUCTURE_REQUEST_INVALID`, as does any other parameter.
- **Empty until the omnibus processing comes**: `{ "transfers": [], "nextCursor": null }`.
- One transfer by its id: [Get a Transfer](https://docs.aureahub.com/docs/structures-transfer-get.md). Statuses and reasons: [Account Structures](https://docs.aureahub.com/docs/guide-account-structures.md) › A Transfer's Statuses.
- For `owner`, `tenantadmin`, `non_signing_admin`, `signer`, `approver`, `editor`, `viewer` and `auditor`, on their own tenant, with an access token.

## A Transfer

| Field | Meaning |
| --- | --- |
| kind | `sweep` — a collection wallet to the treasury —, or `withdrawal` — a pool account to a destination, debited from a customer's claim. |
| status | `queued` (a withdrawal waiting for a pool account), `planned`, `signed`, `sent`, `confirmed`, `failed`, `skipped` (a sweep not made). |
| reason | Why it failed, was skipped or waits: `REVERTED`, `DROPPED`, `SUPERSEDED`, `INTERRUPTED`, `NO_POOL_WALLET`, `SWEEP_NO_GAS`, `WALLET_NOT_CUSTODIAL`, or a signing rule's refusal code such as `ACCOUNT_FROZEN`; else `null`. |
| chainId, asset, amount | The chain, the asset (`native` or the token's address) and the amount moved, in its smallest unit. |
| accountId | The customer: a sweep's collection account, a withdrawal's customer. |
| sourceAccountId | The account whose wallet sends it: a sweep's collection account; a withdrawal's pool account, once one is picked (`null` while queued). |
| walletId, fromAddress | That account's wallet and its address, once picked. |
| toAddress, toAccountId | Where it goes: the treasury's wallet and account for a sweep; a withdrawal's destination, with `toAccountId` `null`. |
| txHash, nonce | Its transaction, once signed. |
| blockNumber, fee | Once mined: the block, and the network fee paid — in the smallest unit of the chain's native coin, whatever the asset. |
| operationId | Its operation — `SWEEP` for a sweep, `TRANSFER` for a withdrawal ([Get an Operation](https://docs.aureahub.com/docs/operation-get.md)) —, once signed; else `null`. |
| externalId | A withdrawal's id of yours; `null` for a sweep. |
| createdAt, updatedAt, sentAt, finishedAt | When it was recorded, last changed, handed to the node, and ended (`confirmed`, `failed` or `skipped`). |

## Endpoint

### `GET /v1/structures/{network}/transfers`

Authentication: bearer token required.

The omnibus's sweeps and pool withdrawals on a network, newest first.

**Path parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `network` | string | yes | `mainnet` or `testnet` |

**Query parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | no | `sweep` or `withdrawal` |
| `status` | string | no | `queued`, `planned`, `signed`, `sent`, `confirmed`, `failed` or `skipped` |
| `accountId` | string (uuid) | no | A customer's collection account, or a pool account that paid |
| `cursor` | string | no | The previous page's `nextCursor` |
| `limit` | integer | no | 1–200, default 50 |

**Responses**

`200` OK

```json
{
  "transfers": [
    {
      "id": "482892fb-a38c-4abd-90cd-ea8755233426",
      "network": "mainnet",
      "kind": "withdrawal",
      "status": "confirmed",
      "reason": null,
      "chainId": 8453,
      "asset": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
      "amount": "125000000",
      "accountId": "f22d2b25-338e-444c-93ef-71693565f346",
      "sourceAccountId": "a9dcb8c6-9bee-4900-b792-cd01bd77820b",
      "walletId": "9ef4730c-d384-4359-b0ed-820e2297b0f9",
      "fromAddress": "0x79c7756b0b77d992feadf0d152503c40de259750",
      "toAddress": "0x16d5a1f0c4ac41af8ca8414a8090069a941de2a2",
      "toAccountId": null,
      "txHash": "0xb4e10c04bdc9f13651394ea7b1f20614dc4876674f45c56841ffed78904a555c",
      "nonce": 17,
      "blockNumber": 52434210,
      "fee": "2104300000000",
      "operationId": "8f61be6a-bbb5-4bda-bc49-9088c89d003d",
      "externalId": "payout-2026-10-14-0042",
      "createdAt": "2026-10-14T06:41:12.330Z",
      "updatedAt": "2026-10-14T06:42:20.871Z",
      "sentAt": "2026-10-14T06:42:10.215Z",
      "finishedAt": "2026-10-14T06:42:20.871Z"
    },
    {
      "id": "3d8f139b-71b6-4ca0-8914-c4b8c1b4f898",
      "network": "mainnet",
      "kind": "sweep",
      "status": "confirmed",
      "reason": null,
      "chainId": 8453,
      "asset": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
      "amount": "310000000",
      "accountId": "3cb0a94e-6358-445d-99a2-021749a80e0a",
      "sourceAccountId": "3cb0a94e-6358-445d-99a2-021749a80e0a",
      "walletId": "b3c7e49b-3606-4a3f-b70e-4b99089e6112",
      "fromAddress": "0x9b110eb821d36a918c1a5d1f2847423b68be6dbd",
      "toAddress": "0xb24cc5e109b3e56860ca0dd97c3688c6e2ad111c",
      "toAccountId": "3e3f3321-a179-423c-b4fb-8a4fe6bc5756",
      "txHash": "0x30058c89ef888bd8abf50907df9613976ed64a32398ce2a1c6c50086ced34c28",
      "nonce": 4,
      "blockNumber": 52418377,
      "fee": "1843200000000",
      "operationId": "aadf3bb5-b2c9-43a6-b196-deff09bc1785",
      "externalId": null,
      "createdAt": "2026-10-13T22:00:03.118Z",
      "updatedAt": "2026-10-13T22:01:04.527Z",
      "sentAt": "2026-10-13T22:00:03.904Z",
      "finishedAt": "2026-10-13T22:01:04.527Z"
    }
  ],
  "nextCursor": "MjAyNi0xMC0xM1QyMjowMDowMy4xMThafDNkOGYxMzliLTcxYjYtNGNhMC04OTE0LWM0YjhjMWI0Zjg5OA"
}
```

`200` Not enabled

```json
{
  "transfers": [],
  "nextCursor": null
}
```

`400` Invalid

```json
{
  "statusCode": 400,
  "error": "BadRequestError",
  "message": "Invalid request",
  "details": {
    "code": "STRUCTURE_REQUEST_INVALID",
    "errors": ["kind: Invalid enum value. Expected 'sweep' | 'withdrawal', received 'deposit'"]
  }
}
```

**Example request**

```bash
curl "https://api.aureahub.com/v1/structures/mainnet/transfers?kind=withdrawal&status=failed" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

---

Web version: https://docs.aureahub.com/#structures-transfers-list