List Payouts

GET

vendor

payouts

curl 'http://localhost:9000/vendor/payouts?status=paid' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { payouts, count } = await client.vendor.payouts.query({
  status: "paid",
})

{
  "payouts": [
    {
      "id": "pout_01HXYZ",
      "display_id": 42,
      "amount": 1250,
      "currency_code": "usd",
      "status": "paid",
      "created_at": "2026-01-15T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns the payouts belonging to the current seller.

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.

string | string[]

Filter by payout status: pending, processing, paid, failed, canceled.

object

Filter by creation date using operators like $gte, $lte, $gt, $lt.

object

Filter by update date using operators like $gte, $lte, $gt, $lt.

Response

object[]

Show properties

string

The payout’s ID.

number

Human-readable payout number.

number

The payout amount.

string

The payout currency.

enum

One of pending, processing, paid, failed, canceled.

object

Provider-specific data.

string

Creation timestamp.

string

Update timestamp.

number

Total number of payouts.

number

Number of items skipped.

number

Maximum number of items returned.

curl 'http://localhost:9000/vendor/payouts?status=paid' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { payouts, count } = await client.vendor.payouts.query({
  status: "paid",
})

{
  "payouts": [
    {
      "id": "pout_01HXYZ",
      "display_id": 42,
      "amount": 1250,
      "currency_code": "usd",
      "status": "paid",
      "created_at": "2026-01-15T10:00:00.000Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/vendor/payouts?status=paid' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { payouts, count } = await client.vendor.payouts.query({
  status: "paid",
})

{
  "payouts": [
    {
      "id": "pout_01HXYZ",
      "display_id": 42,
      "amount": 1250,
      "currency_code": "usd",
      "status": "paid",
      "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