Record a payment provider's payout as the provider reports it now

POST /payouts

Record a payment provider's payout as the provider reports it now: its net in its own currency, its status and its lines — the charges and refunds it settles, the provider's fees, chargebacks, adjustments, reserves and conversions, each signed by what it did to the payout.

Each charge and refund is matched to the payment or refund it settles, at commit: by the paymentId / refundId it names, else the providerTransactionId a payment carries, else on its order (orderId, or the orderReference of an order) by amount; a line that names a payment or refund the organization has not got, another provider's or one another payout settled is 409 PayoutItemUnknown, and what finds nothing stays unmatched for the reconciliation. The payout's id is derived from provider and providerPayoutId. Appends fulfillment.payout-recorded. Idempotent by content: the same report appends nothing, a different one (its status moving to paid) replaces it.

Access

Requires payments:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: the same report appends nothing, a different one (its status moving to paid) replaces it.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.payout-recorded

What a fact is: Facts and the journal.

AI agent tool

No agent tool. a payout is the payment provider's report, recorded by its channel app's sync or the payout import; never typed by a person or an agent

Connecting an agent: AI agents.

Example

curl

curl -X POST 'https://fulfillment.getmanifold.io/payouts' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "provider": "channel",
  "providerPayoutId": "payout-88120331",
  "currency": "AUD",
  "netCents": 10286,
  "status": "paid",
  "issuedAt": "2026-10-22T00:00:00.000Z",
  "items": [
    {
      "kind": "charge",
      "amountCents": 10600,
      "currency": "AUD",
      "providerTransactionId": "txn-6620019931",
      "orderReference": "#1342"
    },
    {
      "kind": "fee",
      "amountCents": -314,
      "currency": "AUD",
      "description": "Processing fee"
    }
  ]
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/payouts", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "provider": "channel",
    "providerPayoutId": "payout-88120331",
    "currency": "AUD",
    "netCents": 10286,
    "status": "paid",
    "issuedAt": "2026-10-22T00:00:00.000Z",
    "items": [
      {
        "kind": "charge",
        "amountCents": 10600,
        "currency": "AUD",
        "providerTransactionId": "txn-6620019931",
        "orderReference": "#1342"
      },
      {
        "kind": "fee",
        "amountCents": -314,
        "currency": "AUD",
        "description": "Processing fee"
      }
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "provider": "channel",
  "providerPayoutId": "payout-88120331",
  "currency": "AUD",
  "netCents": 10286,
  "status": "paid",
  "issuedAt": "2026-10-22T00:00:00.000Z",
  "items": [
    {
      "kind": "charge",
      "amountCents": 10600,
      "currency": "AUD",
      "providerTransactionId": "txn-6620019931",
      "orderReference": "#1342"
    },
    {
      "kind": "fee",
      "amountCents": -314,
      "currency": "AUD",
      "description": "Processing fee"
    }
  ]
}

Response · 200 · application/json

{
  "id": "pyo_01a15ab0-b690-7221-8eac-d7e8f90a1b2c",
  "provider": "channel",
  "providerPayoutId": "payout-88120331",
  "currency": "AUD",
  "netCents": 10286,
  "status": "paid",
  "issuedAt": "2026-10-22T00:00:00.000Z",
  "fx": {
    "currency": "AUD",
    "home": "AUD",
    "rate": 1,
    "rateDate": "2026-10-22",
    "source": "same"
  },
  "unaccountedCents": 0,
  "recordedAt": "2026-10-22T01:05:33.640Z",
  "updatedAt": "2026-10-22T01:05:33.640Z",
  "items": [
    {
      "kind": "charge",
      "amountCents": 10600,
      "currency": "AUD",
      "providerTransactionId": "txn-6620019931",
      "paymentId": "pay_01a15aa0-c7a0-7331-9fbd-e8f90a1b2c3d",
      "orderId": "ord_01a15a80-9470-7001-8c8a-b5c6d7e8f90a",
      "orderReference": "#1342",
      "matched": true,
      "homeCents": 10600
    },
    {
      "kind": "fee",
      "amountCents": -314,
      "currency": "AUD",
      "description": "Processing fee",
      "matched": false,
      "homeCents": -314
    }
  ],
  "homeNetCents": 10286
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: fulfillment-manager.openapi.json. Base URL https://fulfillment.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`PayoutItemUnknown` id, reason	A payout line names a payment or refund Manifold does not have. `id` names it.	Record the payment first, or leave the line out.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`502`

Refusal	What it means	What to do
`InventoryUnavailable` reason	The inventory service did not answer, so nothing changed.	Send the same request again shortly.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.