Skip to main content
GET
List payout adjustments

Purpose

List payout adjustments in your store.

When to use

To find adjustments by vendor, status or date. Uses page-based pagination (page, limit). 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

Pay vendors with the API

Next step

Get a payout adjustment

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

Filter by vendor ObjectId

status
enum<string>
Available options:
UNPAID,
PAID
dateFrom
string<date-time>
dateTo
string<date-time>
page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Response

List of payout adjustments

success
enum<boolean>
required
Available options:
true
data
object
required