Tools
Every tool returns a readable summary followed by the raw API response as JSON. Invalid input is rejected before any network call.
create_payment_link
Section titled “create_payment_link”creates Bills someone and returns a hosted payment link. Needs at least one route (REQUEST_DESTINATION_ID or REQUEST_ROUTES).
| Input | Type | Required | Notes |
|---|---|---|---|
amount |
string | yes | Plain decimal in the route’s token, e.g. "250". |
currency |
string | no | Token to be paid in, e.g. USDC, USDT. |
network |
string | no | e.g. base, arbitrum, ethereum, sepolia. |
for |
string | no | Who is billed, e.g. Acme. Saved locally so you can ask about it by name. |
note |
string | no | What it’s for, e.g. logo design. |
With neither, the default (first) route is used. If more than one route matches, it asks which network instead of guessing.
Returns securePaymentUrl, requestIds, token, and the route used.
list_routes
Section titled “list_routes”read-only The receiving routes you can be paid through: token, network and wallet, with the default marked. No inputs.
create_invoice
Section titled “create_invoice”creates Creates an invoice with a chosen token, network and denomination.
| Input | Type | Required | Notes |
|---|---|---|---|
amount |
string | yes | Plain decimal, e.g. "19.99". |
paymentCurrency |
string | yes | e.g. USDC-base, USDC-mainnet, fUSDC-sepolia. |
invoiceCurrency |
string | no | Defaults to paymentCurrency. Use USD to bill dollars. |
payee |
address | no | Defaults to REQUEST_PAYEE. |
payer |
address | no | Expected payer. |
reference |
string | no | Your note or invoice number, up to 200 characters. |
for |
string | no | Who is billed. Saved locally. |
repeat |
daily · weekly · monthly · quarterly · yearly |
no | Bill again on this schedule. |
startDate |
YYYY-MM-DD |
no | First billing date for a repeating invoice; today or later, default today. |
Returns requestId, paymentReference.
check_invoice
Section titled “check_invoice”read-only Whether an invoice is paid, with payments and transaction hashes. Ask by ID or by name.
| Input | Type | Required | Notes |
|---|---|---|---|
requestId |
hex string | one of these | |
who |
string | one of these | Name or note it was created with; checks up to 5 matching invoices. |
Returns hasBeenPaid, status, requestAmount, invoiceCurrency, paymentCurrency, payments[], txHash and more.
list_invoices
Section titled “list_invoices”read-only Invoices created with your credentials, newest first, with exact totals owed and paid per currency.
| Input | Type | Required | Notes |
|---|---|---|---|
status |
unpaid · paid · all |
no | Default all. |
period |
this_month · last_month · last_30_days · this_year |
no | By creation date (UTC). |
olderThanDays |
integer | no | e.g. 14 for “older than 2 weeks”. |
walletAddress |
address | no | Only invoices paid to this wallet. |
who |
string | no | Only invoices saved with this name or note. |
limit |
1–100 | no | How many to show, default 20. Totals cover all matches. |
offset |
integer | no | For paging. |
stop_recurring_invoice
Section titled “stop_recurring_invoice”changes Stops a repeating invoice, or restarts it with resume: true. Invoices already created are unchanged.
| Input | Type | Required | Notes |
|---|---|---|---|
requestId |
hex string | one of these | |
who |
string | one of these | If several recurring invoices match, it asks which one. |
resume |
boolean | no | true restarts it. |
get_payment_link
Section titled “get_payment_link”read-only The saved payment link for an invoice, so you can send it again. This server never sends messages; it gives you the link to send.
| Input | Type | Required |
|---|---|---|
requestId |
hex string | one of these |
who |
string | one of these |
Only links created with create_payment_link on the same computer are saved.
get_payment_transactions
Section titled “get_payment_transactions”read-only The unsigned transactions a payer signs to pay an invoice.
| Input | Type | Required | Notes |
|---|---|---|---|
requestId |
hex string | yes | |
payerWallet |
address | no | Enables balance, gas and approval checks. |
Returns transactions[] (to, data, value) and metadata (needsApproval, approvalTransactionIndex, hasEnoughBalance, hasEnoughGas).
find_currency
Section titled “find_currency”read-only Looks up currency IDs.
| Input | Type | Required |
|---|---|---|
symbol |
string | one of these |
network |
string | one of these |