Skip to main content
GET
/
payouts
TypeScript
import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.payouts.list();

  console.log(result);
}

run();
[
  {
    "id": "<string>",
    "invoiceId": "<string>",
    "amount": 123,
    "currency": "<string>",
    "status": "pending",
    "periodStart": "<string>",
    "periodEnd": "<string>",
    "createdAt": "<string>",
    "initiatedAt": "<string>",
    "paidAt": "<string>",
    "mode": "internal",
    "partner": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "image": "<string>",
      "payoutsEnabledAt": "<string>",
      "country": "<string>",
      "tenantId": "<string>",
      "groupId": "<string>"
    },
    "description": "<string>",
    "failureReason": "<string>",
    "user": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "image": "<string>"
    }
  }
]
Payouts endpoints require an Business plan subscription or higher.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
status
enum<string>

Filter the list of payouts by their corresponding status.

Available options:
pending,
processing,
processed,
sent,
completed,
failed,
canceled
​
partnerId
string

Filter the list of payouts by the associated partner. When specified, takes precedence over tenantId.

​
tenantId
string

Filter the list of payouts by the associated partner's tenantId (their unique ID within your database).

​
invoiceId
string

Filter the list of payouts by invoice ID (the unique ID of the invoice you receive for each batch payout you process on Dub). Pending payouts will not have an invoice ID.

​
sortBy
enum<string>
default:amount

The field to sort the list of payouts by.

Available options:
amount,
initiatedAt,
paidAt
​
sortOrder
enum<string>
default:desc

The sort order for the list of payouts.

Available options:
asc,
desc
​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:100

The number of items per page.

Required range: 0 < x <= 100
Example:

50

Response

The list of payouts.

​
id
string
required
​
invoiceId
string | null
required
​
amount
number
required
​
currency
string
required
​
status
enum<string>
required
Available options:
pending,
processing,
processed,
sent,
completed,
failed,
canceled
​
periodStart
string | null
required
​
periodEnd
string | null
required
​
createdAt
string
required
​
initiatedAt
string | null
required
​
paidAt
string | null
required
​
mode
enum<string> | null
required
Available options:
internal,
external
​
partner
object
required
​
description
string | null
​
failureReason
string | null
​
user
object