Get Invoice Payment Status Tool
get-invoice-payment-statusReturns the authoritative payment state for one authorized invoice without exposing payment links or provider identifiers. Use to get invoice payment status in the connected business. Returns payment, scope.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"invoice_id": "<invoice_id>"
},
"name": "get-invoice-payment-status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invoice_id | Yes | Invoice ID returned by search-invoices. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | Yes | Authorization scope of this result; data remains restricted to the connected business. | |
| payment | Yes | Payment data returned by the authorized safe projection. |