Skip to main content
PATCH
Update 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.

Path Parameters

id
string
required

Body

application/json
vendorId
string
amount
number
type
enum<string>
Available options:
ADDITION,
DEDUCTION
comments
string
date
string<date-time>

The date this adjustment applies to. Returned as customItemDate, the stored field name.

Response

Adjustment updated

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