Create a payout batch

curl --request POST \
  --url https://api.introw.io/api/v1/payout-batches \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "periodStart": "2026-01-01T00:00:00.000Z",
  "periodEnd": "2026-03-31T23:59:59.000Z"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({periodStart: '2026-01-01T00:00:00.000Z', periodEnd: '2026-03-31T23:59:59.000Z'})
};

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

import requests

url = "https://api.introw.io/api/v1/payout-batches"

payload = {
    "periodStart": "2026-01-01T00:00:00.000Z",
    "periodEnd": "2026-03-31T23:59:59.000Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "id": "pbt_9h8g7f6e5d4c3b2a1z0w9v8u",
    "periodStart": "2026-01-01T00:00:00.000Z",
    "periodEnd": "2026-03-31T23:59:59.000Z",
    "payouts": [
      {
        "payoutId": "pay_2x7n4q8z0w1a2b3c4d5e6f7g",
        "partnerId": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8"
      },
      {
        "payoutId": "pay_3y8o5r9a1x2b3c4d5e6f7g8h",
        "partnerId": "ptn_02JWL7Z9A9R8K9K9K9K9K9K9K9"
      }
    ]
  }
}

{
  "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>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Create a payout batch

Opens a payout run for one period and, optionally, a draft payout for each partner on it. A batch is what the Payouts page lists as a period: it holds one payout per partner, and each partner gets their own commission statement. Use it when a run covers several partners, so they stay one batch instead of one batch each. Pass partnerIds to open every partner’s payout in this call, or leave it out and add partners one at a time with POST /api/v1/payouts using the returned batch id. The payouts open empty unless attachPendingLines is set.

POST

api

payout-batches

curl --request POST \
  --url https://api.introw.io/api/v1/payout-batches \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "periodStart": "2026-01-01T00:00:00.000Z",
  "periodEnd": "2026-03-31T23:59:59.000Z"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({periodStart: '2026-01-01T00:00:00.000Z', periodEnd: '2026-03-31T23:59:59.000Z'})
};

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

import requests

url = "https://api.introw.io/api/v1/payout-batches"

payload = {
    "periodStart": "2026-01-01T00:00:00.000Z",
    "periodEnd": "2026-03-31T23:59:59.000Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "id": "pbt_9h8g7f6e5d4c3b2a1z0w9v8u",
    "periodStart": "2026-01-01T00:00:00.000Z",
    "periodEnd": "2026-03-31T23:59:59.000Z",
    "payouts": [
      {
        "payoutId": "pay_2x7n4q8z0w1a2b3c4d5e6f7g",
        "partnerId": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8"
      },
      {
        "payoutId": "pay_3y8o5r9a1x2b3c4d5e6f7g8h",
        "partnerId": "ptn_02JWL7Z9A9R8K9K9K9K9K9K9K9"
      }
    ]
  }
}

{
  "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>"
  }
}

{
  "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

periodStart

string<date-time>

required

Start of the commission period the batch covers.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

periodEnd

string<date-time>

required

End of the commission period the batch covers. Must be on or after periodStart.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

partnerIds

string[]

Partners to open a draft payout for. Omit to create the batch empty and add partners later with POST /payouts.

Minimum string length: 1

attachPendingLines

boolean

Attach each partner's pending commission lines whose period overlaps this one, the way creating a payout run in the app does. Defaults to false, so the payouts open empty and you attach lines yourself with POST /commission-lines.

Response

Payout batch created successfully.

data

object

required

Show child attributes

INTROW API

Use cases

Partner API

Forms API

CRM API

Commission payouts API

Commission lines API

Collaboration API

Embed API

Affiliate API

Create a payout batch

Authorizations

Body

Response