Skip to main content
GET
Get Payout Batch Detail
V2 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

Error Responses

401
404

Example