Skip to main content
POST
Create a commission line

Authorizations

x-api-key
string
header
required

Introw API key shown once when the credential is created.

Body

application/json
partnerId
string
required

Introw partner the commission line is for.

Minimum string length: 1
amount
string
required

Commission amount as a decimal string, e.g. "500.00". Must be non-zero.

Minimum string length: 1
currency
string
required

ISO 4217 currency code, e.g. "USD".

Required string length: 3
description
string | null

Free-text description of the commission line.

Maximum string length: 2000
sourceAmount
string | null

Originating deal/source amount the commission was derived from.

payoutId
string | null

Optional payout to attach the line to on creation. When omitted, the line is created in the pending pool and can be picked up by a future payout batch.

Minimum string length: 1

Response

Commission line created successfully.

data
object
required