Documentation
Payments
payments.payout_summary
REST
ShippingPOST /api/v1/payments/payout_summaryMCP tool
Livepayments.payout_summaryExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Payments domain.
Operating contract
What the payment processor is holding for this shop and what it has paid out recently — the answer to 'when is our card money landing'.
available_cents is what could be paid out now; pending_cents is what is still settling. They are separate figures per currency and adding them together is wrong.
next_payout is the soonest payout that has not arrived yet, with the date it is expected. A status of failed with a failure_message is the thing worth telling a shop owner about — it usually means their bank details need attention, and nobody is going to notice on their own.
NOTHING HERE MOVES MONEY. There is no capability that starts a payout, changes a payout schedule or touches the connected account. This is a window, not a lever.
connected: false means this shop never finished connecting a payment processor, so there is nothing to report and no card money to wait for — it is not an error.
read_ok: false means the processor could not be reached. Say that rather than reporting a zero balance: those are very different sentences and only one of them is alarming.
Who may call it
- Permission
invoices.accessThe caller must hold Invoices at the ACT level. A read-only dashboard grant on the same section is refused.- Plan
- Every planNo plan gate. Available on every Service VIN plan.
- Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.- Rate class
expensiveCounted against the expensive budget — a model call, a document render or a fan-out scan.
Partial answers
omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. There is no cursor here — narrow the filter instead.
Do not summarise from a truncated response
Input
| Field | Type | Description |
|---|---|---|
| limit | integer1–50 | How many recent payouts to return, 1-50. Defaults to 10. Default:10 |
Output
| Field | Type | Description |
|---|---|---|
| connected | boolean | — |
| charges_enabled | boolean | — |
| read_ok | boolean | — |
| balances | object[] | — |
| balances[].currency | string | — |
| balances[].available_cents | number | — |
| balances[].pending_cents | number | — |
| next_payout | object | null | — |
| next_payout.id | string | — |
| next_payout.amount_cents | number | — |
| next_payout.currency | string | — |
| next_payout.arrives_at | string | — |
| next_payout.status | string | — |
| next_payout.failure_message | string | null | — |
| payouts | object[] | — |
| payouts[].id | string | — |
| payouts[].amount_cents | number | — |
| payouts[].currency | string | — |
| payouts[].arrives_at | string | — |
| payouts[].status | string | — |
| payouts[].automatic | boolean | — |
| payouts[].failure_message | string | null | — |
| omitted | number | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/payments/payout_summary \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"limit":10}'const res = await fetch("https://www.servicevin.com/api/v1/payments/payout_summary", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 10
}),
});
// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/payments/payout_summary",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"limit": 10
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["code"])
data = payload["data"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "payments.payout_summary",
"arguments": {
"limit": 10
}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold invoices.access. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many expensive calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |