Get Payout Batch Detail
curl --request GET \
--url https://production-api.puppetvendors.com/payouts/batches/{batchId} \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/payouts/batches/{batchId}"
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/batches/{batchId}', 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/batches/{batchId}",
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/batches/{batchId}"
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/batches/{batchId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/batches/{batchId}")
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
Get Payout Batch Detail
Get detailed breakdown of a specific payout batch
GET
/
payouts
/
batches
/
{batchId}
Get Payout Batch Detail
curl --request GET \
--url https://production-api.puppetvendors.com/payouts/batches/{batchId} \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/payouts/batches/{batchId}"
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/batches/{batchId}', 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/batches/{batchId}",
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/batches/{batchId}"
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/batches/{batchId}")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/payouts/batches/{batchId}")
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 the detailed breakdown of a specific payout batch, including individual line items, amounts, and status information. Each payout transaction can contain one or more batches.Use Cases
- Payout detail page — Show the full breakdown when a vendor clicks into a specific payout
- Line item audit — Review exactly which orders and amounts are included in a batch
- Dispute investigation — Verify payout calculations for a specific batch
Headers
string
required
A valid vendor JWT. Requires
payouts:read scope.Path Parameters
string
required
The
_id of the payout batch.Query Parameters
string
Filter by vendor ID (24-character hex string). Defaults to the authenticated vendor.
Response
200
{
"success": true,
"data": {
"_id": "507f1f77bcf86cd799439055",
"status": "paid",
"processedAt": "2026-05-01T12:00:00Z",
"amount": 5000.00,
"currency": "USD",
"transactionId": "txn_1PqR2sT3uV4wX5yZ",
"paymentMethod": "stripe",
"itemCount": 12,
"lineItems": [
{
"orderId": "664a1b2c3d4e5f6a7b8c9d30",
"orderName": "#1042",
"productTitle": "Classic T-Shirt",
"variantTitle": "Red / Medium",
"sku": "TSH-RED-M",
"quantity": 2,
"sales": 49.98,
"commission": 7.50,
"payout": 42.48,
"fulfilledAt": "2026-04-28T15:00:00Z"
},
{
"orderId": "664a1b2c3d4e5f6a7b8c9d31",
"orderName": "#1043",
"productTitle": "Premium Hoodie",
"variantTitle": "Navy / Large",
"sku": "HOD-NAV-L",
"quantity": 1,
"sales": 89.99,
"commission": 13.50,
"payout": 76.49,
"fulfilledAt": "2026-04-29T10:30:00Z"
}
],
"createdAt": "2026-04-30T18:00:00Z"
}
}
Error Responses
401
{ "success": false, "error": { "message": "Invalid or expired token" } }
404
{ "success": false, "error": { "message": "Batch not found", "code": "NOT_FOUND" } }
Example
curl -X GET "https://production-api.puppetvendors.com/payouts/batches/507f1f77bcf86cd799439055" \
-H "x-access-token: YOUR_VENDOR_JWT"
Was this page helpful?