Skip to main content
GET
/
payouts
/
{payoutId}
Get Payout
curl --request GET \
  --url https://staging-api.puppetvendors.com/payouts/{payoutId} \
  --header 'x-access-token: <api-key>'
import requests

url = "https://staging-api.puppetvendors.com/payouts/{payoutId}"

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://staging-api.puppetvendors.com/payouts/{payoutId}', 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://staging-api.puppetvendors.com/payouts/{payoutId}",
  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://staging-api.puppetvendors.com/payouts/{payoutId}"

	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://staging-api.puppetvendors.com/payouts/{payoutId}")
  .header("x-access-token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/payouts/{payoutId}")

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_body
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Retrieve detailed information for a single payout transaction belonging to the authenticated vendor. The response includes the transaction summary, status, payment method, and a breakdown of individual line items included in the payout.
Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.

​
Use Cases

  • Payout detail view — Display a full payout breakdown in a vendor portal
  • Invoice generation — Pull payout details for creating vendor invoices
  • Payment verification — Confirm payout amounts and line item breakdown

​
Path Parameters

​
payoutId
string
required
The payout transaction’s MongoDB ObjectId.

​
Response

200
{
  "success": true,
  "data": {
    "transaction": {
      "_id": "507f1f77bcf86cd799439050",
      "transactionId": "TXN-2024-001042",
      "status": "paid",
      "amount": 1250.75,
      "currency": "GBP",
      "itemCount": 12,
      "paymentMethod": "stripe",
      "processedAt": "2024-06-20T14:00:00.000Z",
      "createdAt": "2024-06-15T10:30:00.000Z"
    },
    "items": [
      {
        "_id": "507f1f77bcf86cd799439060",
        "orderNumber": 1042,
        "orderName": "#1042",
        "lineItemName": "Widget Pro - Large / Blue",
        "lineItemSku": "WP-LG-BL",
        "quantity": 2,
        "sales": 279.99,
        "commission": 39.20,
        "payout": 240.79
      },
      {
        "_id": "507f1f77bcf86cd799439061",
        "orderNumber": 1043,
        "orderName": "#1043",
        "lineItemName": "Widget Mini - Red",
        "lineItemSku": "WM-RD",
        "quantity": 5,
        "sales": 149.95,
        "commission": 21.00,
        "payout": 128.95
      }
    ]
  }
}

​
Error Response

404
{
  "success": false,
  "error": {
    "message": "Payout not found",
    "code": "NOT_FOUND"
  }
}

​
Example

curl -X GET "https://staging-api.puppetvendors.com/payouts/507f1f77bcf86cd799439050" \
  -H "x-access-token: YOUR_VENDOR_JWT_TOKEN"