List Payouts
curl --request GET \
--url https://production-api.puppetvendors.com/v1/payouts \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/v1/payouts"
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/v1/payouts', 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/v1/payouts",
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/v1/payouts"
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/v1/payouts")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/v1/payouts")
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 Payouts
Retrieve payout line items with filtering
GET
/
v1
/
payouts
List Payouts
curl --request GET \
--url https://production-api.puppetvendors.com/v1/payouts \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/v1/payouts"
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/v1/payouts', 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/v1/payouts",
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/v1/payouts"
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/v1/payouts")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/v1/payouts")
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_bodyOverview
Returns a paginated list of payout line items, showing what is owed, paid, and outstanding for each order item. Supports filtering by vendor, date range, payment status, and fulfillment status.Use Cases
- Generate payout reports for accounting or tax preparation
- Reconcile payments by comparing paid vs. unpaid balances
- Build a custom payout dashboard for merchant oversight
- Automate payment triggers by monitoring unpaid items via API
Query Parameters
string
Filter by vendor ID.
string
Start date in
YYYY-MM-DD format.string
End date in
YYYY-MM-DD format.string
Payment status filter:
"paid", "partial", or "unpaid".string
Fulfillment status:
"fulfilled" or "unfulfilled".number
Results per page. Default:
100.number
Number of results to skip. Default:
0.Response
200
{
"total": 85,
"nextOffset": 100,
"payouts": [
{
"_id": "...",
"orderNumber": 1042,
"orderName": "#1042",
"vendorId": "6157faecbebcf01bf49097d9",
"vendorName": "acme supplies",
"lineItemName": "Classic T-Shirt - Large",
"payout": 194.13,
"paid": 194.13,
"balance": 0,
"date": "2024-03-15T00:00:00.000Z"
}
]
}
Example
# Unpaid payouts for a vendor in March 2024
curl -X GET "https://api.puppetvendors.com/v1/payouts?vendorId=6157fa...&status=unpaid&start=2024-03-01&end=2024-03-31" \
-H "x-access-token: YOUR_JWT_TOKEN"
Was this page helpful?