latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Payments

List transfer batches

Lists transfer batches for the authenticated organization or project scope.

get/v1/payments/transfer-batches

Query parameters

walletstring

Filter by source wallet walletId.

Example:privy_wallet_123

Filter by source wallet walletId.

tokenstring

Filter by token symbol or mint.

Example:SOL

Filter by token symbol or mint.

Filter by transfer batch status.

Example:processing

Filter by transfer batch status.

externalIdstring

Filter by caller-provided batch correlation ID.

Example:payroll_2026_06_30

Filter by caller-provided batch correlation ID.

pageinteger

Page number (1-based).

Example:1

Page number (1-based).

pageSizeinteger

Number of batches per page.

Example:20

Number of batches per page.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

Transfer batch list

Example response

{
  "data": [
    {
      "id": "xbatch_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "externalId": "payroll_2026_06_30",
      "sourceWalletId": "privy_wallet_123",
      "sourceAddress": "So11111111111111111111111111111111111111112",
      "token": "SOL",
      "status": "processing",
      "totalAmount": "1000.00",
      "recipientCount": 20,
      "transactionCount": 1,
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "requestId": "req_example"
  }
}