To let an assistant use these tools, grant Insurance operations on the consent screen, or just
Billing under its Fine-tune. The scope is billing.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
Premium collection and payments. Read payments (with whether each can be refunded) and collection schedules (scope 'attention' lists the ones that need action). Changes move real money, refund_payment and record_manual_payment especially, so confirm with the user first. collect_premium_now, and record_manual_payment with the same idempotency_token, are safe to retry: a repeated call can't charge twice.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
list_payments
Read List payments
The payment ledger across the org's policies, newest first: premiums, refunds, chargebacks, claim payouts and reinsurance flows.
Arguments
| Field | Type | Description |
|---|---|---|
| kind | string |
One of: "first_premium", "ongoing_premium", "refund", "chargeback", "adjustment", "reinsurer_ceded_premium", "claim_payout", "reinsurer_claim_recovery"
|
| status | string |
One of: "authorised", "captured", "collected", "failed", "refunded", "disputed", "reversed", "pending"
|
| policy_id | string | Only payments on this policy |
| processor_reference | string | Substring match on the processor reference |
| limit | integer | Max rows (1-100, default 25) |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_payment
Read Get a payment
One ledger row in full, with whether it can be refunded right now.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Payment id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
refund_payment
Write Refund a payment
Full refund of a single collected payment back to the customer via Stripe. Irreversible and moves real money: confirm with the operator before calling.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Payment id |
| reason required | string | Why the payment is being refunded |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
change_billing_day
Write Change the billing day
Move the day of the month premiums are collected on; the next collection date is recomputed. Only allowed while the schedule is collecting normally.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Premium schedule id |
| day required | integer | Day of the month (1-28) |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
record_manual_payment
Write Take a manual payment
One-off ad-hoc charge against the policy's Direct Debit mandate, outside the scheduled run. Moves real money: confirm amount and reason with the operator. Supply a fresh UUID as idempotency_token; reuse it only when retrying the same charge.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Premium schedule id |
| amount_pence required | integer | Charge amount in pence |
| reason required | string | Why this charge is being taken |
| idempotency_token required | string | Caller-minted UUID; same token = same charge on retry |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |