Skip to main content
GET
List payout transactions

Purpose

List past payouts with their batches.

When to use

To show payout history or reconcile. Your payout appears here once it completes. Each payout has payoutMethod (for example other) and comment. batches[].markAsPaid has marked only. Part of the Pay vendors with the API flow.

Request and response

The parameters, request body, code examples (curl and other languages) and a full response example are shown below this section. They are generated from the OpenAPI spec.

Errors

Every error has the shape {"success": false, "error": {"code", "message", "errorId", "details"}}. Branch on error.code.

Previous step

Get a payout

Next step

Retry a payout batch (if a batch failed)

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Query Parameters

vendorId
string

Only runs that paid this vendor, with batches narrowed to its batches

status
enum<string>

Only batches in this mapped status (and the runs that have one)

Available options:
pending,
paid,
failed,
cancelled
dateMin
string

Created-at lower bound, YYYY-MM-DD (shop timezone) or ISO

dateMax
string

Created-at upper bound, YYYY-MM-DD (shop timezone) or ISO

Substring search on transactionId or batchId

Maximum string length: 200
first
integer

Number of runs to return (most recent first)

Required range: 1 <= x <= 100
after
string

Cursor for forward pagination

last
integer

Number of runs to return (backward pagination)

Required range: 1 <= x <= 100
before
string

Cursor for backward pagination

Response

Payout runs in the standard cursor envelope

success
boolean
data
object