Skip to main content
DELETE
Delete a payout adjustment

Purpose

Permanently delete an unpaid payout adjustment.

When to use

To remove an adjustment you created by mistake. Paid adjustments cannot be deleted. 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

Response

Adjustment deleted