Payout Summary
curl --request GET \
--url https://production-api.puppetvendors.com/payouts/summary \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/payouts/summary"
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/summary', 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/summary",
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/summary"
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/summary")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/summary")
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
Payout Summary
Get a high-level summary of payout totals and the next scheduled payout
GET
/
payouts
/
summary
Payout Summary
curl --request GET \
--url https://production-api.puppetvendors.com/payouts/summary \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/payouts/summary"
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/summary', 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/summary",
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/summary"
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/summary")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/summary")
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 high-level summary of the vendor’s payout totals, including the most recent payout, the next scheduled payout, and aggregate amounts. Useful for building a payouts dashboard.Use Cases
- Payouts dashboard — Show “Total received”, “Pending”, and “Next payout” cards
- Financial overview — Give vendors a snapshot of their earnings at a glance
- Payout scheduling visibility — Display when the next automated payout will run
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 the date range.
string
ISO 8601 upper bound on the date range.
Response
200
{
"success": true,
"data": {
"totalReceived": 12500.00,
"totalPending": 3200.00,
"totalScheduled": 1500.00,
"currency": "USD",
"shopTimezone": "America/New_York",
"previousPayout": {
"amount": 5000.00,
"status": "paid",
"date": "2026-05-01T00:00:00Z",
"latestBatchId": "507f1f77bcf86cd799439055"
},
"nextPayout": {
"amount": 1500.00,
"status": "scheduled",
"estimatedDate": "2026-06-01T00:00:00Z",
"type": "automated",
"startDate": "2026-05-01T00:00:00Z",
"endDate": "2026-05-31T23:59:59Z"
},
"itemCount": 156
}
}
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/summary?dateMin=2026-01-01T00:00:00Z&dateMax=2026-05-31T23:59:59Z" \
-H "x-access-token: YOUR_VENDOR_JWT"
Was this page helpful?