v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

Affiliate

Void (cancel) a previously recorded affiliate payout (by payoutId).

Marks the payout as voided, restores balances, and records the admin and reason. Requires the stores.affiliates.update permission.

patch/stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}

storeIdstring uuid required

customerIdstring uuid required

payoutIdstring uuid required

reasonstring required

A non‐empty reason describing why this payout was voided.

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error