List Payout Accounts

GET

vendor

payout-accounts

curl 'http://localhost:9000/vendor/payout-accounts' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { payout_accounts } = await client.vendor.payoutAccounts.query()

{
  "payout_accounts": [
    {
      "id": "pacc_01HXYZ",
      "status": "active",
      "onboarding": { "id": "onb_01HXYZ", "data": { "url": "https://connect.stripe.com/setup/..." } },
      "created_at": "2026-01-15T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns the payout accounts linked to the current seller, each with its onboarding.

A seller typically has at most one payout account, so the first entry is usually the one you need.

Query parameters

number

default:"20"

Maximum number of items to return.

number

default:"0"

Number of items to skip.

string

Field to sort by, prefixed with - for descending order.

string

Comma-separated fields to include in the response.

Response

object[]

Show properties

string

The payout account’s ID.

enum

One of pending, active, restricted, rejected.

object

Provider-specific account data.

object

Context passed when the account was created.

object

The account’s onboarding record (id, data, context).

string

Creation timestamp.

string

Update timestamp.

number

Total number of payout accounts.

number

Number of items skipped.

number

Maximum number of items returned.

curl 'http://localhost:9000/vendor/payout-accounts' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { payout_accounts } = await client.vendor.payoutAccounts.query()

{
  "payout_accounts": [
    {
      "id": "pacc_01HXYZ",
      "status": "active",
      "onboarding": { "id": "onb_01HXYZ", "data": { "url": "https://connect.stripe.com/setup/..." } },
      "created_at": "2026-01-15T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/vendor/payout-accounts' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { payout_accounts } = await client.vendor.payoutAccounts.query()

{
  "payout_accounts": [
    {
      "id": "pacc_01HXYZ",
      "status": "active",
      "onboarding": { "id": "onb_01HXYZ", "data": { "url": "https://connect.stripe.com/setup/..." } },
      "created_at": "2026-01-15T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response