Skip to main content
PATCH
Void (cancel) a previously recorded affiliate payout (by payoutId).
Voiding a recorded payout restores the amount to the affiliate’s balance. Use it when a payout was recorded in error or the transfer failed - not to reverse money you actually sent.

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required
customerId
string<uuid>
required
payoutId
string<uuid>
required

Body

application/json

Form used by an admin to void (cancel) an existing affiliate payout.

reason
string
required

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

Required string length: 1 - 256

Response

The object was successfully updated.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

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

code
string | null

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

data
object

A record of an affiliate’s earnings being paid out (e.g., converted into store credit).

Last modified on August 2, 2026