Record what was paid to the carrier for a booked parcel

POST /orders/{orderId}/consignments/{consignmentId}/payment

Record what was paid to the carrier for a booked parcel: amountCents (tax included, in the booked charge's currency; omitted, the booked charge) and the taxCents inside it (omitted, the booked tax), with the bank's reference.

Booked at the payment day's rate: accounting relieves the accrued carrier charge (2150) against supplier payments clearing (1195), posts what the payment differs from the booking by — a surcharge, a credit — as shipping cost and its tax, and, for a organization on the cash basis, recognises the charge's deferred expense. 409 ConsignmentNotPayable for a consignment that is not booked (not-booked), whose booking carries no charge (no-cost), or that another payment paid (already-paid). Appends fulfillment.consignment-paid. paymentId is required and is the idempotency key: a retry with the same paymentId is acknowledged and appends nothing.

Access

Requires shipping:write.

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

Retries

paymentId is required and is the idempotency key: a retry with the same paymentId is acknowledged and appends nothing.

A retry with the same key answers 200, with what the first call recorded.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.consignment-paid

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_record_carrier_payment (Fulfillment: Record carrier payment), in the parcels toolset.

Connecting an agent: AI agents.

Example

curl

curl -X POST 'https://fulfillment.getmanifold.io/orders/ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9/consignments/cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c/payment' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "paymentId": "cpy_01a15a40-f200-7311-8e25-1b2c3d4e5f60",
  "reference": "SSI-INV-20931"
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/orders/ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9/consignments/cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c/payment", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "paymentId": "cpy_01a15a40-f200-7311-8e25-1b2c3d4e5f60",
    "reference": "SSI-INV-20931"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "paymentId": "cpy_01a15a40-f200-7311-8e25-1b2c3d4e5f60",
  "reference": "SSI-INV-20931"
}

Response · 200 · application/json

{
  "id": "ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9",
  "reference": "WEB-31002",
  "source": {
    "kind": "api"
  },
  "customer": {
    "personId": "psn_01a1588a-0c41-7d2e-9a10-3b5c6d7e8f90",
    "shippingAddressId": "adr_01a1588a-0c41-7d2e-9a10-4c6d7e8f9a01"
  },
  "party": {
    "personId": "psn_01a1588a-0c41-7d2e-9a10-3b5c6d7e8f90",
    "name": "Priya Raman",
    "shipTo": {
      "id": "adr_01a1588a-0c41-7d2e-9a10-4c6d7e8f9a01",
      "address": {
        "firstName": "Priya",
        "lastName": "Raman",
        "company": "Harbour Ceramics",
        "address1": "14 Kiln Street",
        "city": "Fremantle",
        "province": "Western Australia",
        "provinceCode": "WA",
        "country": "Australia",
        "countryCode": "AU",
        "zip": "6160"
      }
    }
  },
  "catalogIds": [
    "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
  ],
  "currency": "AUD",
  "fx": {
    "currency": "AUD",
    "home": "AUD",
    "rate": 1,
    "rateDate": "2026-10-20",
    "source": "same"
  },
  "convention": "exclusive",
  "shippingTaxBasis": {
    "_tag": "calculated",
    "treatment": "domestic",
    "country": "AU",
    "class": "follows-goods",
    "rateBps": 1000
  },
  "shippingMethod": {
    "title": "Standard",
    "code": "STD"
  },
  "number": "SO-01045",
  "serial": 1045,
  "status": "open",
  "lines": [
    {
      "id": "lin_01a159a0-cfd0-70e1-9bf2-b5c6d7e8f90a",
      "sku": "MUG-SPECKLE",
      "name": "Speckled stoneware mug",
      "ordered": 4,
      "removed": false,
      "catalogId": "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e",
      "discountCents": 0,
      "allocated": 4,
      "picked": 4,
      "packed": 4,
      "dispatched": 0,
      "invoiced": 0,
      "returned": 0,
      "unitPriceCents": 2400,
      "listPriceCents": 2400,
      "inclusive": false,
      "taxBasis": {
        "_tag": "calculated",
        "treatment": "domestic",
        "country": "AU",
        "parts": [
          {
            "class": "standard",
            "rateBps": 1000,
            "weight": 1
          }
        ]
      },
      "orderDiscountCents": 0,
      "tax": {
        "inclusive": false,
        "amountCents": 9600,
        "entries": [
          {
            "class": "standard",
            "treatment": "domestic",
            "country": "AU",
            "rateBps": 1000,
            "netCents": 9600,
            "taxCents": 960,
            "source": "manifold"
          }
        ],
        "netCents": 9600,
        "taxCents": 960,
        "grossCents": 10560
      }
    }
  ],
  "workflow": {
    "paymentTerms": "on-account",
    "pick": "manual",
    "pack": "manual",
    "ship": "manual",
    "invoice": "manual",
    "shortfall": "wait",
    "allocation": "single-site-preferred",
    "routing": {
      "order": "rank",
      "decider": "manifold",
      "priority": []
    },
    "routingByCatalog": {}
  },
  "paymentTermsBy": "tenant",
  "createdSequence": 4146,
  "shipments": [
    {
      "id": "shp_01a159a0-cfd0-70e1-9bf2-c6d7e8f90a1b",
      "number": "SH-01063",
      "reference": "auto:ord_01a159a0-cfd0-70e1-9bf2-a4b5c6d7e8f9:1",
      "status": "packed",
      "locationId": "loc_01a0f6b0-1100-7e51-8f62-7a8b9cadbec4",
      "lines": [
        {
          "lineId": "lin_01a159a0-cfd0-70e1-9bf2-b5c6d7e8f90a",
          "sku": "MUG-SPECKLE",
          "quantity": 4
        }
      ],
      "cartons": [
        {
          "packaging": "carton",
          "boxId": "box_01a0f6b4-3e10-7aa1-8c24-2c3d4e5f6071",
          "weightGrams": 1700,
          "size": {
            "lengthMm": 260,
            "widthMm": 210,
            "heightMm": 120
          }
        }
      ],
      "createdAt": "2026-10-20T06:18:33.020Z",
      "updatedAt": "2026-10-20T06:52:10.774Z"
    }
  ],
  "invoices": [],
  "refunds": [],
  "payments": [],
  "notes": [],
  "edits": [],
  "consignments": [
    {
      "id": "cns_01a159c0-d0e0-71f1-8c03-d7e8f90a1b2c",
      "shipmentId": "shp_01a159a0-cfd0-70e1-9bf2-c6d7e8f90a1b",
      "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
      "attempt": 1,
      "status": "booked",
      "service": {
        "code": "7E55",
        "name": "Parcel Post",
        "carrier": "Australia Post"
      },
      "quoted": {
        "priceCents": 1395,
        "currency": "AUD"
      },
      "quote": {
        "quotedAt": "2026-10-20T06:53:02.415Z",
        "rates": [
          {
            "code": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d:7E55",
            "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
            "title": "Australia Post · Parcel Post",
            "service": {
              "code": "7E55",
              "name": "Parcel Post",
              "carrier": "Australia Post"
            },
            "priceCents": 1395,
            "currency": "AUD",
            "etaDays": {
              "min": 2,
              "max": 5
            }
          },
          {
            "code": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d:7J55",
            "carrierAccountId": "car_01a0f6b3-2d00-7a91-9b13-e8f90a1b2c3d",
            "title": "Australia Post · Express Post",
            "service": {
              "code": "7J55",
              "name": "Express Post",
              "carrier": "Australia Post"
            },
            "priceCents": 1980,
            "currency": "AUD",
            "etaDays": {
              "min": 1,
              "max": 2
            }
          }
        ],
        "unanswered": [],
        "estimated": false,
        "unweighed": []
      },
      "trackingHistory": [
        {
          "status": "in-transit",
          "at": "2026-10-20T09:12:00.000Z",
          "detail": "Processed at Perth facility"
        }
      ],
      "requestedAt": "2026-10-20T06:53:30.009Z",
      "updatedAt": "2026-10-21T23:05:19.640Z",
      "booking": {
        "carrier": "Australia Post",
        "service": {
          "code": "7E55",
          "name": "Parcel Post",
          "carrier": "Australia Post"
        },
        "trackingNumbers": [
          "33XYZ0098765"
        ],
        "trackingUrl": "https://auspost.com.au/mypost/track/details/33XYZ0098765",
        "externalId": "ssi-order-905512",
        "cost": {
          "priceCents": 1395,
          "currency": "AUD",
          "taxCents": 127
        }
      },
      "costFx": {
        "currency": "AUD",
        "home": "AUD",
        "rate": 1,
        "rateDate": "2026-10-20",
        "source": "same"
      },
      "label": {
        "contentType": "application/pdf",
        "size": 48213,
        "storedAt": "2026-10-20T06:53:44.105Z"
      },
      "tracking": {
        "status": "in-transit",
        "at": "2026-10-20T09:12:00.000Z",
        "detail": "Processed at Perth facility"
      },
      "payment": {
        "paymentId": "cpy_01a15a40-f200-7311-8e25-1b2c3d4e5f60",
        "amountCents": 1395,
        "taxCents": 127,
        "reference": "SSI-INV-20931",
        "paidAt": "2026-10-21T23:05:19.640Z"
      }
    }
  ],
  "money": {
    "subtotalCents": 9600,
    "charges": {
      "shippingCents": 1500,
      "shippingDiscountCents": 0,
      "discountCents": 0
    },
    "discountCents": 0,
    "tax": {
      "netCents": 11100,
      "taxCents": 1110,
      "grossCents": 12210,
      "breakdown": [
        {
          "class": "standard",
          "treatment": "domestic",
          "country": "AU",
          "rateBps": 1000,
          "exempt": false,
          "taxableCents": 11100,
          "taxCents": 1110
        }
      ]
    },
    "shippingTax": {
      "inclusive": false,
      "amountCents": 1500,
      "entries": [
        {
          "class": "standard",
          "treatment": "domestic",
          "country": "AU",
          "rateBps": 1000,
          "netCents": 1500,
          "taxCents": 150,
          "source": "manifold"
        }
      ],
      "netCents": 1500,
      "taxCents": 150,
      "grossCents": 1650
    },
    "totalCents": 12210,
    "paidCents": 0,
    "refundedCents": 0,
    "balanceCents": 12210,
    "refundOwedCents": 0,
    "status": "unpaid"
  },
  "discounts": [],
  "shortfalls": [],
  "createdAt": "2026-10-20T06:18:33.020Z",
  "updatedAt": "2026-10-21T23:05:19.640Z"
}

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.

`404`

Refusal	What it means	What to do
`FulfillmentOrderNotFound` orderId	No such record in this organization.	Check the id in the path or the body.
`ConsignmentNotFound` consignmentId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`ConsignmentNotPayable` consignmentId, problem	This booking cannot be paid. `problem` says why: not booked, no charge, or paid already.	Check the booking before paying.
`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, with the same key.

`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, with the same key.

How refusals work everywhere: Errors.