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

string
required
The payout transaction’s MongoDB ObjectId.

Response

200

Error Response

404

Example