Skip to main content
GET
List payout adjustments

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