Skip to main content
PATCH
Update a payout adjustment

Purpose

Change an unpaid payout adjustment.

When to use

To correct the amount, type or comment before the adjustment is paid. 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 adjustment

Next step

List pending payouts

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