List Pending Payouts
curl --request GET \
--url https://production-api.puppetvendors.com/payouts/pending \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/payouts/pending"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://production-api.puppetvendors.com/payouts/pending', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.puppetvendors.com/payouts/pending",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://production-api.puppetvendors.com/payouts/pending"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.puppetvendors.com/payouts/pending")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/pending")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_bodyPayouts
List Pending Payouts
List line items that are pending payout with offset pagination
GET
/
payouts
/
pending
List Pending Payouts
curl --request GET \
--url https://production-api.puppetvendors.com/payouts/pending \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/payouts/pending"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://production-api.puppetvendors.com/payouts/pending', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.puppetvendors.com/payouts/pending",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://production-api.puppetvendors.com/payouts/pending"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.puppetvendors.com/payouts/pending")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/pending")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_bodyV2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Return a paginated list of line items that are pending payout for the authenticated vendor. Unlike the transactions endpoint, this uses offset-based pagination (limit/offset) instead of cursors.Use Cases
- Pending earnings table — Show vendors what they have earned but not yet been paid for
- Payout preview — Let vendors see what will be included in the next payout
- Filtered views — Show only refunded or adjusted line items separately
Headers
string
required
A valid vendor JWT. Requires
payouts:read scope.Query Parameters
string
Filter by vendor ID (24-character hex string). Defaults to the authenticated vendor.
string
ISO 8601 lower bound on line item date.
string
ISO 8601 upper bound on line item date.
string
Free-text search (max 200 characters). Searches order names, SKUs, and product titles.
string
Filter by type:
paid · refunded · adjustment.integer
Number of records per page. Min
1, max 500. Defaults to 50.integer
Number of records to skip. Min
0. Defaults to 0.Response
200
{
"success": true,
"data": {
"items": [
{
"_id": "664a1b2c3d4e5f6a7b8c9d40",
"orderId": "664a1b2c3d4e5f6a7b8c9d30",
"orderName": "#1050",
"productTitle": "Classic T-Shirt",
"variantTitle": "Red / Medium",
"sku": "TSH-RED-M",
"quantity": 1,
"type": "paid",
"sales": 24.99,
"commission": 3.75,
"payout": 21.24,
"createdAt": "2026-05-10T08:30:00Z"
},
{
"_id": "664a1b2c3d4e5f6a7b8c9d41",
"orderId": "664a1b2c3d4e5f6a7b8c9d32",
"orderName": "#1048",
"productTitle": "Premium Hoodie",
"variantTitle": "Navy / Large",
"sku": "HOD-NAV-L",
"quantity": 1,
"type": "refunded",
"sales": -89.99,
"commission": -13.50,
"payout": -76.49,
"createdAt": "2026-05-08T11:00:00Z"
}
],
"total": 42,
"limit": 50,
"offset": 0
}
}
Error Responses
401
{ "success": false, "error": { "message": "Invalid or expired token" } }
403
{ "success": false, "error": { "message": "Insufficient scope", "code": "FORBIDDEN" } }
Example
curl -X GET "https://production-api.puppetvendors.com/payouts/pending?lineItemType=paid&limit=25&offset=0" \
-H "x-access-token: YOUR_VENDOR_JWT"
More Examples
Filter refunded itemscurl -X GET "https://production-api.puppetvendors.com/payouts/pending?limit=50&lineItemType=refunded&dateMin=2026-05-01T00:00:00Z" \
-H "x-access-token: YOUR_VENDOR_JWT"
Was this page helpful?