Skip to main content
POST
/
api
/
v1
/
commission-lines
Create a commission line
curl --request POST \
  --url https://api.introw.io/api/v1/commission-lines \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "partnerId": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
  "amount": "500.00",
  "currency": "USD"
}
'
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({partnerId: 'ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8', amount: '500.00', currency: 'USD'})
};

fetch('https://api.introw.io/api/v1/commission-lines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://api.introw.io/api/v1/commission-lines"

payload = {
    "partnerId": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "amount": "500.00",
    "currency": "USD"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "data": {
    "id": "cln_4d5e6f7g8h9i0j1k2l3m4n5o",
    "partnerId": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "payoutId": null,
    "description": "Q1 referral bonus",
    "amount": "500.00",
    "sourceAmount": "10000.00",
    "currency": "USD",
    "status": "PENDING",
    "planName": "Referral plan",
    "periodEnd": "2026-03-31T23:59:59.000Z",
    "createdAt": "2026-04-05T09:00:00.000Z",
    "updatedAt": "2026-04-05T09:00:00.000Z"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

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