Skip to main content
POST
Record a new payout (external or store-credit) for an affiliate (by customerId).
This records a payout, it does not send money. Komerza reduces the affiliate’s balance by the amount; the actual transfer happens between you and your affiliate outside Komerza.Record it only once you have actually paid, or your balances will disagree with reality.

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

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

Body

application/json

Form used by an admin to record a manual affiliate payout.

amount
number<double>
required

The amount to pay out or convert.

Required range: 0.01 <= x <= 1.7976931348623157e+308
convertedToStoreCredit
boolean
required

True = convert into store credit; false = external payout.

comment
string | null

Optional note for auditing.

Maximum string length: 256

Response

The object was successfully created.

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