Check invoice payment

Verify a hosted checkout directly with Topolo Pay. A completed payment is recorded once against the invoice and posted through undeposited funds for later payout reconciliation.

Outcome

Verify a hosted checkout directly with Topolo Pay. A completed payment is recorded once against the invoice and posted through undeposited funds for later payout reconciliation.

Before you start

Verify the intended environment, authenticated identity and specifically approved organization context.
The published application permission is invoices:write. Discover the exact granted canonical Books workspace and bind it separately from action input.
Approve the actual mutation, accounting inputs and any provider/recipient effects before CLI --confirm or MCP confirm:true. Fixture identifiers and simulated provider responses authorize no live operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.invoices.payment_sessions.refresh --detail --json
topolo resources topolo-books --json
topolo workspaces list topolo-books --json

Set BOOKS_WORKSPACE_ID to the exact granted workspace returned by discovery.
documentId: Exact document.id from invoices.list/get or bills.list/get, as appropriate to this action; the displayed invoice number is distinct.
paymentSessionId: Exact session.id from invoices.payment_sessions.list/get, distinct from an accounting payment record.

Request

POST /api/invoices/{documentId}/payment-sessions/{paymentSessionId}/refresh

Inspect and test this action. Save the reviewed input as payload.json; supply credential/resource context separately.

Input fields

Field	Required	Meaning	Schema and constraints
`documentId`	Required	Exact document.id from invoices.list/get or bills.list/get, as appropriate to this action; the displayed invoice number is distinct.	{"type":"string","minLength":1}
`paymentSessionId`	Required	Exact session.id from invoices.payment_sessions.list/get, distinct from an accounting payment record.	{"type":"string","minLength":1}

Inspect nested fields and the complete input schema.

Effects

Reads the checkout from Pay. If Pay confirms completion, records one idempotent receipt against the invoice and posts it to undeposited funds for later payout reconciliation.

Interpret the response

Read $.session.id for the returned invoice_payment_session identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.invoices.get and confirm paid_minor and status, then list the payment sessions and confirm the session is paid.

Inspect the success schema. CLI/MCP add their own transport envelope; CLI --detail requests the full result.

Worked examples

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.

Run a reviewed request

Save the input from the selected worked example as payload.json. Validate and inspect the plan before calling the action; refused examples demonstrate errors and are not instructions to execute.

CLI:

topolo actions validate app_topolo_books.invoices.payment_sessions.refresh --data @payload.json --json
topolo actions plan app_topolo_books.invoices.payment_sessions.refresh --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.invoices.payment_sessions.refresh --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_books.invoices.payment_sessions.refresh",
    "input": {
      "documentId": "doc_f8852615bef8424d9e4d87f8fb6b2592",
      "paymentSessionId": "ips_796bc693e691492581967e05e947bad6"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "documentId": "doc_9f2a",
  "paymentSessionId": "ips_7f3c1b"
}

Captured response · HTTP 401

{
  "error": "API key validation failed"
}

HTTP 401. SDK error code auth_error. Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

Successful response · HTTP 200

Input · payload.json:

{
  "documentId": "doc_f8852615bef8424d9e4d87f8fb6b2592",
  "paymentSessionId": "ips_796bc693e691492581967e05e947bad6"
}

Captured response · HTTP 200

{
  "document": {
    "id": "doc_f8852615bef8424d9e4d87f8fb6b2592",
    "organization_id": "org_invoice-pay-route_muvnpf1314",
    "workspace_id": "ws_invoice-pay-route_muvnpf1314",
    "kind": "invoice",
    "contact_id": "con_28c191fab9be4c3e9439dbe4559769e3",
    "number": "INV-000001",
    "reference": null,
    "issue_date": "2026-09-08",
    "due_date": "2026-09-22",
    "period_key": "2026-09",
    "currency": "GBP",
    "exchange_rate": null,
    "subtotal_minor": 12000,
    "tax_minor": 0,
    "total_minor": 12000,
    "base_total_minor": 12000,
    "paid_minor": 12000,
    "status": "paid",
    "notes": null,
    "posted_event_id": null,
    "source": "manual",
    "source_document_id": null,
    "created_at": "2026-10-05T19:42:28.706Z",
    "updated_at": "2026-10-05T19:42:28.735Z",
    "sequence_no": 1,
    "approved_at": "2026-10-05T19:42:28.708Z",
    "sent_at": null,
    "amounts_include_tax": 0,
    "design_project_id": null,
    "design_export_id": null,
    "design_rendered_at": null,
    "brand_kit_id": null,
    "brand_version_id": null,
    "written_off_minor": 0
  },
  "payments": [
    {
      "id": "pay_1888c9e18e494104b5c3db4d6fc26bd1",
      "organization_id": "org_invoice-pay-route_muvnpf1314",
      "workspace_id": "ws_invoice-pay-route_muvnpf1314",
      "document_id": "doc_f8852615bef8424d9e4d87f8fb6b2592",
      "paid_on": "2026-10-05",
      "amount_minor": 12000,
      "currency": "GBP",
      "reference": "Topolo Pay pi_invoice",
      "bank_line_id": null,
      "source": "topolo_pay",
      "source_payment_id": "pi_invoice",
      "created_at": "2026-10-05T19:42:28.734Z",
      "updated_at": "2026-10-05T19:42:28.734Z",
      "ledger_account_id": null,
      "settlement_gross_minor": null,
      "settlement_fee_minor": null,
      "settlement_net_minor": null,
      "settlement_currency": null,
      "settlement_exchange_rate": null,
      "settlement_reference": null,
      "settlement_fee_details": null
    }
  ],
  "session": {
    "id": "ips_796bc693e691492581967e05e947bad6",
    "organization_id": "org_invoice-pay-route_muvnpf1314",
    "workspace_id": "ws_invoice-pay-route_muvnpf1314",
    "document_id": "doc_f8852615bef8424d9e4d87f8fb6b2592",
    "merchant_id": "mrc_books",
    "order_id": "books-doc_f8852615bef8424d9e4d87f8fb6b2592-0-mrc_books-mpa_checkout_books-1",
    "session_id": "cs_invoice_replacement",
    "amount_minor": 12000,
    "currency": "GBP",
    "status": "paid",
    "provider_status": "paid",
    "payment_id": "pay_1888c9e18e494104b5c3db4d6fc26bd1",
    "created_at": "2026-10-05T19:42:28.729Z",
    "updated_at": "2026-10-05T19:42:28.733Z",
    "completed_at": "2026-10-05T19:42:28.733Z",
    "provider_account_id": "mpa_checkout_books",
    "payment_url": "https://books.test/invoice/ish_a86b94eb205442da85b4c30848fbfca2"
  },
  "paymentRecorded": true
}

HTTP 200. Call app_topolo_books.invoices.get and confirm paid_minor and status, then list the payment sessions and confirm the session is paid.

Successful response · HTTP 200

Input · payload.json:

{
  "documentId": "doc_f8852615bef8424d9e4d87f8fb6b2592",
  "paymentSessionId": "ips_796bc693e691492581967e05e947bad6"
}

Captured response · HTTP 200

{
  "document": {
    "id": "doc_f8852615bef8424d9e4d87f8fb6b2592",
    "organization_id": "org_invoice-pay-route_muvnpf1314",
    "workspace_id": "ws_invoice-pay-route_muvnpf1314",
    "kind": "invoice",
    "contact_id": "con_28c191fab9be4c3e9439dbe4559769e3",
    "number": "INV-000001",
    "reference": null,
    "issue_date": "2026-09-08",
    "due_date": "2026-09-22",
    "period_key": "2026-09",
    "currency": "GBP",
    "exchange_rate": null,
    "subtotal_minor": 12000,
    "tax_minor": 0,
    "total_minor": 12000,
    "base_total_minor": 12000,
    "paid_minor": 12000,
    "status": "paid",
    "notes": null,
    "posted_event_id": null,
    "source": "manual",
    "source_document_id": null,
    "created_at": "2026-10-05T19:42:28.706Z",
    "updated_at": "2026-10-05T19:42:28.735Z",
    "sequence_no": 1,
    "approved_at": "2026-10-05T19:42:28.708Z",
    "sent_at": null,
    "amounts_include_tax": 0,
    "design_project_id": null,
    "design_export_id": null,
    "design_rendered_at": null,
    "brand_kit_id": null,
    "brand_version_id": null,
    "written_off_minor": 0
  },
  "payments": [
    {
      "id": "pay_1888c9e18e494104b5c3db4d6fc26bd1",
      "organization_id": "org_invoice-pay-route_muvnpf1314",
      "workspace_id": "ws_invoice-pay-route_muvnpf1314",
      "document_id": "doc_f8852615bef8424d9e4d87f8fb6b2592",
      "paid_on": "2026-10-05",
      "amount_minor": 12000,
      "currency": "GBP",
      "reference": "Topolo Pay pi_invoice",
      "bank_line_id": null,
      "source": "topolo_pay",
      "source_payment_id": "pi_invoice",
      "created_at": "2026-10-05T19:42:28.734Z",
      "updated_at": "2026-10-05T19:42:28.734Z",
      "ledger_account_id": null,
      "settlement_gross_minor": null,
      "settlement_fee_minor": null,
      "settlement_net_minor": null,
      "settlement_currency": null,
      "settlement_exchange_rate": null,
      "settlement_reference": null,
      "settlement_fee_details": null
    }
  ],
  "session": {
    "id": "ips_796bc693e691492581967e05e947bad6",
    "organization_id": "org_invoice-pay-route_muvnpf1314",
    "workspace_id": "ws_invoice-pay-route_muvnpf1314",
    "document_id": "doc_f8852615bef8424d9e4d87f8fb6b2592",
    "merchant_id": "mrc_books",
    "order_id": "books-doc_f8852615bef8424d9e4d87f8fb6b2592-0-mrc_books-mpa_checkout_books-1",
    "session_id": "cs_invoice_replacement",
    "amount_minor": 12000,
    "currency": "GBP",
    "status": "paid",
    "provider_status": "paid",
    "payment_id": "pay_1888c9e18e494104b5c3db4d6fc26bd1",
    "created_at": "2026-10-05T19:42:28.729Z",
    "updated_at": "2026-10-05T19:42:28.739Z",
    "completed_at": "2026-10-05T19:42:28.733Z",
    "provider_account_id": "mpa_checkout_books",
    "payment_url": "https://books.test/invoice/ish_a86b94eb205442da85b4c30848fbfca2"
  },
  "paymentRecorded": false
}

HTTP 200. Call app_topolo_books.invoices.get and confirm paid_minor and status, then list the payment sessions and confirm the session is paid.

Verify the result

Call app_topolo_books.invoices.get and confirm paid_minor and status, then list the payment sessions and confirm the session is paid.

Errors and recovery

auth_error (HTTP 401): Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

These are observed local refusals. Shared authentication, schema validation and resource authorization can also refuse before the route. Preserve the actual error, details and request id.

Recovery boundary

A completed Pay payment and its Books receipt are accounting history. Refunds and payout reconciliation are separate governed actions.

Get an invoice: Read one invoice with its lines and the payments against it.
List invoice payment sessions: List the Pay checkout sessions created for an invoice, newest first, including their amount, settlement state and stable Books customer-page URL without exposing the provider checkout URL.
List invoices: List invoices newest first. Filter by status, contact or issue date, search the number, reference and notes, and sort by issue date, due date, number, total or status. The response carries the outstanding total for the filtered set.

Check invoice payment

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Run a reviewed request

Refused response · auth_error

Successful response · HTTP 200

Successful response · HTTP 200

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence