Update a payout

curl --request PATCH \
  --url https://api.introw.io/api/v1/payouts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "stage": "APPROVED",
  "poNumber": "PO-ACME-2026-Q1",
  "metadata": "Remittance reference: ACME-Q1-2026\nBank: paid from our EUR account\n\nQuestions? [email protected]"
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    stage: 'APPROVED',
    poNumber: 'PO-ACME-2026-Q1',
    metadata: 'Remittance reference: ACME-Q1-2026\nBank: paid from our EUR account\n\nQuestions? [email protected]'
  })
};

fetch('https://api.introw.io/api/v1/payouts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.introw.io/api/v1/payouts/{id}"

payload = {
    "stage": "APPROVED",
    "poNumber": "PO-ACME-2026-Q1",
    "metadata": "Remittance reference: ACME-Q1-2026
Bank: paid from our EUR account

Questions? [email protected]"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "id": "pay_2x7n4q8z0w1a2b3c4d5e6f7g",
    "partner": {
      "id": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
      "name": "Acme Partners"
    },
    "batchId": "pbt_9h8g7f6e5d4c3b2a1z0w9v8u",
    "periodStart": "2026-01-01T00:00:00.000Z",
    "periodEnd": "2026-03-31T23:59:59.000Z",
    "amount": {
      "value": "4250.00",
      "currency": "USD"
    },
    "stage": "APPROVED",
    "poNumber": "PO-ACME-2026-Q1",
    "metadata": "Remittance reference: ACME-Q1-2026\nBank: paid from our EUR account\n\nQuestions? [email protected]",
    "createdAt": "2026-04-05T09:00:00.000Z",
    "updatedAt": "2026-04-08T14:30: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>"
  }
}

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

PATCH

api

payouts

{id}

Update a payout

curl --request PATCH \
  --url https://api.introw.io/api/v1/payouts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "stage": "APPROVED",
  "poNumber": "PO-ACME-2026-Q1",
  "metadata": "Remittance reference: ACME-Q1-2026\nBank: paid from our EUR account\n\nQuestions? [email protected]"
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    stage: 'APPROVED',
    poNumber: 'PO-ACME-2026-Q1',
    metadata: 'Remittance reference: ACME-Q1-2026\nBank: paid from our EUR account\n\nQuestions? [email protected]'
  })
};

fetch('https://api.introw.io/api/v1/payouts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.introw.io/api/v1/payouts/{id}"

payload = {
    "stage": "APPROVED",
    "poNumber": "PO-ACME-2026-Q1",
    "metadata": "Remittance reference: ACME-Q1-2026
Bank: paid from our EUR account

Questions? [email protected]"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "id": "pay_2x7n4q8z0w1a2b3c4d5e6f7g",
    "partner": {
      "id": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
      "name": "Acme Partners"
    },
    "batchId": "pbt_9h8g7f6e5d4c3b2a1z0w9v8u",
    "periodStart": "2026-01-01T00:00:00.000Z",
    "periodEnd": "2026-03-31T23:59:59.000Z",
    "amount": {
      "value": "4250.00",
      "currency": "USD"
    },
    "stage": "APPROVED",
    "poNumber": "PO-ACME-2026-Q1",
    "metadata": "Remittance reference: ACME-Q1-2026\nBank: paid from our EUR account\n\nQuestions? [email protected]",
    "createdAt": "2026-04-05T09:00:00.000Z",
    "updatedAt": "2026-04-08T14:30: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>"
  }
}

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

Authorizations

x-api-key

string

header

required

Introw API key shown once when the credential is created.

Path Parameters

string

required

Payout identifier.

Minimum string length: 1

Body

application/json

stage

enum<string>

Set the payout stage to reflect your finance workflow.

Available options:

DRAFT,

PENDING_REVIEW,

PENDING_INVOICE,

APPROVED,

SCHEDULED,

PENDING_PAYMENT,

PAID,

DECLINED,

POSTPONED,

BLOCKED,

FAILED

poNumber

string | null

Partner purchase order number. Pass null to clear it.

metadata

string | null

Free-text block printed on the commission statement PDF, below the commission table. Line breaks are kept, so starts a new line on the PDF. The statement is rebuilt with the new text the next time it is viewed, downloaded, or sent. Pass null to clear it.

Maximum string length: 2000

Response

Payout updated 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

Update a payout

Authorizations

Path Parameters

Body

Response