Skip to main content
POST
Create 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.

Body

application/json
vendorId
string
required
Example:

"507f1f77bcf86cd799439011"

amount
number
required

Always positive; the sign comes from type.

Example:

25.5

type
enum<string>
required
Available options:
ADDITION,
DEDUCTION
comments
string
date
string<date-time>

The date this adjustment applies to, which decides the payout period it lands in. Defaults to now when omitted. Returned as customItemDate, the stored field name.

Response

Adjustment created

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