List Payouts
curl --request GET \
--url https://production-api.puppetvendors.com/payouts \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/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/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/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/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/payouts")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/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 vendor-scoped payout transactions with cursor-based pagination
GET
/
payouts
List Payouts
curl --request GET \
--url https://production-api.puppetvendors.com/payouts \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/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/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/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/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/payouts")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/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_bodyV2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Retrieve a paginated list of payout transactions for the authenticated vendor. Results include transaction status, amounts, processing dates, and item counts. Only payouts belonging to the vendor are returned.Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.
Use Cases
- Payout dashboard — Display pending and completed payouts in a vendor portal
- Accounting reconciliation — Export payout data for bookkeeping
- Payment tracking — Monitor payout statuses and amounts
Query Parameters
string
Filter by payout status. One of:
pending, paid, failed, cancelled.string
Filter by date (minimum, ISO 8601). Example:
2024-01-01T00:00:00Z.string
Filter by date (maximum, ISO 8601).
integer
Number of items to return, forward pagination (1-100).
string
Cursor for forward pagination.
integer
Number of items to return, backward pagination (1-100).
string
Cursor for backward pagination.
Response
200
{
"success": true,
"data": {
"transactions": [
{
"_id": "507f1f77bcf86cd799439050",
"transactionId": "TXN-2024-001042",
"status": "paid",
"amount": 1250.75,
"currency": "GBP",
"itemCount": 12,
"processedAt": "2024-06-20T14:00:00.000Z",
"createdAt": "2024-06-15T10:30:00.000Z"
},
{
"_id": "507f1f77bcf86cd799439051",
"transactionId": "TXN-2024-001038",
"status": "pending",
"amount": 840.50,
"currency": "GBP",
"itemCount": 8,
"processedAt": null,
"createdAt": "2024-06-18T09:15:00.000Z"
}
],
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTA1MCJ9",
"endCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTA1MSJ9",
"totalCount": 25
}
}
}
Example
curl -X GET "https://production-api.puppetvendors.com/payouts?status=pending&first=20" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
More Examples
Filter unpaid payoutscurl -X GET "https://production-api.puppetvendors.com/payouts?first=20&status=unpaid&fulfillment=fulfilled" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
curl -X GET "https://production-api.puppetvendors.com/payouts?first=50&dateMin=2026-04-01T00:00:00Z&dateMax=2026-04-30T23:59:59Z" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
Was this page helpful?