--- updatedAt: 2026-02-28T11:28:56.000Z agentTools: projectIndex: https://neutronpay.readme.io/llms.txt --- # Tools Reference Complete reference for all 14 tools available in the Neutron MCP server. Each tool maps to one or more Neutron API endpoints. ## Account Tools ### neutron\_authenticate Verify your API credentials and get an access token. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ------------------------------------------- | | *(none)* | — | — | Uses credentials from environment variables | **Returns:** Account ID, access token, token expiry. **Example prompt:** *"Authenticate with Neutron"* *** ### neutron\_get\_account Get account details including display name, status, country, and timezone. | Parameter | Type | Required | Description | | --------- | ---- | -------- | -------------------------- | | *(none)* | — | — | Uses authenticated account | **Example prompt:** *"Show my Neutron account info"* *** ### neutron\_get\_wallets List all wallets with current balances. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------------------------------- | | *(none)* | — | — | Returns all wallets for the account | **Example prompt:** *"What are my wallet balances?"* *** ### neutron\_get\_wallet Get details of a specific wallet. | Parameter | Type | Required | Description | | ---------- | ------ | -------- | -------------------- | | `walletId` | string | ✅ | Wallet ID to look up | **Example prompt:** *"Show details for wallet wal\_abc123"* *** ## Transaction Tools ### neutron\_create\_transaction Create a new transaction. Supports Lightning, Bitcoin on-chain, USDT, and fiat payouts. This is the most versatile tool — it maps to the unified [Create Transaction](/reference/createtransaction) endpoint. | Parameter | Type | Required | Description | | --------------------- | ------ | -------- | -------------------------------------------------------------------------- | | `sourceCurrency` | string | ✅ | Source currency (`BTC`, `USDT`, `VND`, etc.) | | `sourceMethod` | string | ✅ | Source method (`neutronpay`, `lightning`, `on-chain`) | | `sourceAmount` | number | ❌ | Amount on source side (set source OR dest, not both) | | `destCurrency` | string | ✅ | Destination currency | | `destMethod` | string | ✅ | Dest method (`neutronpay`, `lightning`, `on-chain`, `tron`, `vnd-instant`) | | `destAmount` | number | ❌ | Amount on destination side | | `destAddress` | string | ❌ | Bitcoin/TRON address (for on-chain/tron sends) | | `destPaymentRequest` | string | ❌ | Bolt11 invoice (for Lightning sends) | | `destBankAcctNum` | string | ❌ | Bank account number (for fiat payouts) | | `destInstitutionCode` | string | ❌ | Bank institution code (for fiat payouts) | | `destRecipientName` | string | ❌ | Recipient legal name (for fiat payouts) | | `destCountryCode` | string | ❌ | Recipient country code (for fiat payouts) | | `extRefId` | string | ❌ | Your external reference ID | **Example prompts:** * *"Send 500 sats to via Lightning"* * *"Create a transaction to send 0.001 BTC to bc1q..."* * *"Convert 100 USDT to BTC in my wallet"* *** ### neutron\_confirm\_transaction Confirm a quoted transaction to execute it. | Parameter | Type | Required | Description | | --------------- | ------ | -------- | ------------------------- | | `transactionId` | string | ✅ | Transaction ID to confirm | **Example prompt:** *"Confirm transaction d5a2c7b4-3456-..."* *** ### neutron\_get\_transaction Get status and details of a specific transaction. | Parameter | Type | Required | Description | | --------------- | ------ | -------- | ------------------------- | | `transactionId` | string | ✅ | Transaction ID to look up | **Example prompt:** *"What's the status of my last transaction?"* **Transaction states (`txnState`):** | State | Meaning | Action | | ------------ | ------------------------------ | ---------------------------------- | | `quoted` | Created, awaiting confirmation | Call `neutron_confirm_transaction` | | `processing` | Confirmed, payment in flight | Wait | | `completed` | Payment delivered ✅ | Done | | `failed` | Payment failed | Retry or investigate | | `expired` | Invoice/transaction timed out | Create a new one | *** ### neutron\_list\_transactions List transactions with optional filters. | Parameter | Type | Required | Description | | ----------- | ------ | -------- | -------------------------------------------------------- | | `status` | string | ❌ | Filter by status (`completed`, `quoted`, `failed`, etc.) | | `method` | string | ❌ | Filter by method (`lightning`, `on-chain`, etc.) | | `currency` | string | ❌ | Filter by currency | | `startDate` | string | ❌ | Start of date range (ISO 8601) | | `endDate` | string | ❌ | End of date range (ISO 8601) | **Example prompts:** * *"Show my last 10 transactions"* * *"List all completed Lightning transactions this week"* *** ## Lightning Tools ### neutron\_create\_lightning\_invoice Create a Lightning invoice (BOLT11) to receive Bitcoin. Returns the payment request string and a hosted QR code page URL. | Parameter | Type | Required | Description | | ------------ | ------ | -------- | -------------------------------------------- | | `amountSats` | number | ⚡ | Amount in satoshis (use this OR `amountBtc`) | | `amountBtc` | number | ⚡ | Amount in BTC (use this OR `amountSats`) | | `memo` | string | ❌ | Description for the invoice | | `expiry` | number | ❌ | Expiry time in seconds (default: 3600) | | `extRefId` | string | ❌ | Your external reference ID | > ⚡ = At least one of these fields is required (provide either `amountSats` OR `amountBtc`, not both). > 💡 This is a convenience tool — it wraps `create_transaction` + `confirm_transaction` into a single call for the common "receive Lightning payment" flow. **Example prompts:** * *"Create a Lightning invoice for 10,000 sats"* * *"Generate an invoice for $5 worth of Bitcoin with memo 'Coffee payment'"* *** ## Webhook Tools ### neutron\_create\_webhook Register a webhook to receive event notifications. | Parameter | Type | Required | Description | | --------- | ------ | -------- | --------------------------------- | | `url` | string | ✅ | Callback URL (must be HTTPS) | | `secret` | string | ✅ | Secret for signature verification | **Example prompt:** *"Set up a webhook to with secret 'mysecret123'"* *** ### neutron\_list\_webhooks List all registered webhooks. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ------------------------------------ | | *(none)* | — | — | Returns all webhooks for the account | *** ### neutron\_update\_webhook Update a webhook's URL or secret. | Parameter | Type | Required | Description | | ----------- | ------ | -------- | -------------------- | | `webhookId` | string | ✅ | Webhook ID to update | | `url` | string | ❌ | New callback URL | | `secret` | string | ❌ | New secret | *** ### neutron\_delete\_webhook Remove a registered webhook. | Parameter | Type | Required | Description | | ----------- | ------ | -------- | -------------------- | | `webhookId` | string | ✅ | Webhook ID to delete | *** ## Exchange Rate Tools ### neutron\_get\_rate Get current exchange rates for BTC against 28+ currencies. | Parameter | Type | Required | Description | | --------- | ---- | -------- | --------------------------- | | *(none)* | — | — | Returns all available rates | **Returns:** BTC exchange rates for USD, EUR, VND, CAD, GBP, JPY, and more. **Example prompts:** * *"What's the current BTC/USD rate?"* * *"How much is 0.01 BTC in VND?"* *** ## Tool → API Mapping | MCP Tool | API Endpoint | Docs | | -------------------------- | --------------------------------------------- | -------------------------------------------------------------- | | `authenticate` | POST `/api/v2/authentication/token-signature` | [Auth](/reference/authentication) | | `get_account` | GET `/api/v2/account/{id}` | [Account](/reference/getaccount) | | `get_wallets` | GET `/api/v2/account/{id}/wallet/` | [Wallets](/reference/getwallets) | | `get_wallet` | GET `/api/v2/account/{id}/wallet/{walletId}` | [Wallet](/reference/getwallet) | | `create_transaction` | POST `/api/v2/transaction/` | [Create](/reference/createtransaction) | | `confirm_transaction` | PUT `/api/v2/transaction/{id}/confirm` | [Confirm](/reference/confirmtransaction) | | `get_transaction` | GET `/api/v2/transaction/{id}` | [Get](/reference/gettransactionstatus) | | `list_transactions` | GET `/api/v2/transaction` | [List](/reference/listtransactions) | | `create_lightning_invoice` | POST + PUT `/api/v2/transaction/` | [Lightning](/reference/receive-bitcoin-with-lightning-invoice) | | `create_webhook` | POST `/api/v2/webhook` | [Create](/reference/createwebhook) | | `list_webhooks` | GET `/api/v2/webhook` | [List](/reference/listwebhooks) | | `update_webhook` | PUT `/api/v2/webhook/{id}` | [Update](/reference/updatewebhook) | | `delete_webhook` | DELETE `/api/v2/webhook/{id}` | [Remove](/reference/removewebhook) | | `get_rate` | GET `/api/v2/rate` | [Rates](/reference/getexchangerates) | ## Related * [Quick Start](/reference/mcp-quickstart) — Install and configure * [Neutron MCP Overview](/reference/mcp-overview) — What MCP is and how it works * [npm: neutron-mcp](https://www.npmjs.com/package/neutron-mcp) — Package page