Skip to main content
GET
Get a payout adjustment

Purpose

Get one payout adjustment by id.

When to use

To check an adjustment’s amount and status (UNPAID or 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

List payout adjustments

Next step

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

Response

Adjustment details

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