payware
NPM · @PAYWARE/MCP-SERVER
payware A2A payments API for merchants, ISVs and payment institutions
Available components
Last scanned (15 hours ago)
Scores higher than 64% of npm servers
Category Finance and Payments
How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score → Why this is hard to score →
Supply Chain Security98
- No malware found by supply-chain analysis.Pass
- No known CVEs affecting this package version or its production dependencies.Pass
- No install/post-install scripts declared.Pass
- 43 of 120 dependencies flagged as unhealthy. View diagnostics → Partial
Provenance & Transparency45
- Source repository is publicly reachable at the declared URL. View diagnostics → Pass
- Provenance check failed: no build-provenance attestation is published. See how to fix → View diagnostics → Fail
- Clear OSI-approved license (MIT).Pass
- Actively maintained (last published 1 days ago).Pass
- Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail
Schema Quality & AI Usability58
- AI-judged instruction clarity (good).Pass
- Context-footprint check failed: tool/resource definitions use about 19669 tokens (~262/item across 75 items; 75 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management92
- Stability check failed: the tool surface changed between 1.4.0 and 2.2.2: 5 tool removals, 1 breaking changes, 8 additions. See how to fix → Fail
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 100% of tool parameters carry a description.Pass
Tool Safety100
- No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.Pass
- All 6 tool(s) whose name or description implies an irreversible operation declare an MCP destructiveHint annotation.Pass
- An AI judge read all 75 captured unit(s) of tool text and found none that tries to manipulate the model reading it.Pass
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Checks we ran (16)
- Malware scan
- Known CVEs
- Install scripts
- Dependency health
- Source repository
- Provenance
- License
- Maintenance
- Security disclosure
- Schema quality
- Stability
- Tool coverage
- Injection markers
- Destructive annotations
- Judged manipulation
- MCP protocol
Does not apply to this package (2)
- Endpoint SecurityScored on hosted endpoints only. A package has no live endpoint of its own for us to probe.
- Transport & ReachabilityScored on hosted endpoints only. A package has no live endpoint of its own for us to probe.
The score does not measure everything. What the score does not measure →
Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 14 Nov 26 +11
- Known CVEs: unverified → pass ▲ security
- Dependency health: unverified → 0.84 ▲ functional
- 13 Nov 26 −10
- Stability: fail → unverified ▼ security
- Known CVEs: pass → unverified ▼ security
- Tool safety: pass → unverified ▼ security
- Capabilities: pass → unverified ▼ functional
- Dependency health: 0.84 → unverified ▼ functional
- Tool coverage: 100 → unverified ▼ functional
- Package version: 1.5.0 → 2.2.2 functional
- Package version: 2.2.1 → 2.2.2 functional
- 12 Nov 26 +14
- Malware scan: unverified → pass ▲ security
- 11 Nov 26 0
- Malware scan: unverified → pass ▲ security
- Package version: 2.2.0 → 2.2.1 functional
- 10 Nov 26 −15
- Malware scan: pass → unverified ▼ security
- Schema quality: 15981 → 19594 ▼ functional
- Package version: 2.1.0 → 2.2.0 functional
- 8 Nov 26 +15
- Malware scan: unverified → pass ▲ security
- 7 Nov 26 −15
- Malware scan: pass → unverified ▼ security
- Package version: 2.0.1 → 2.1.0 functional
- 6 Nov 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 89 to 92.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 15 Nov 2026 · Analysed npm/@payware/mcp-server@2.2.2
Provenance No attestation
The registry publishes no build provenance for this version, so there is nothing to verify.
| Result | No attestation |
|---|---|
| Ecosystem | npm |
Background: How many MCP packages publish verified provenance →
Dependencies 120 packages
| Packages resolved | 120 |
|---|---|
| Stale | 43 |
| Tree resolution | Complete |
Background: SBOMs and build attestations, explained →
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability. A tool's description is untrusted text the model reads on every call, which is what makes this list a security surface and not just an inventory: how tool poisoning works →
payware_authentication_create_jwt_token ~179
[Merchant] Create JWT token for payware API authentication according to official documentation
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key - accepts PEM format with/without headers or raw base64 content. Uses environment-specific private key as default. |
| requestBody | object|string | – | Request body for a POST, PUT or PATCH, which then needs contentSha256. An object is serialized once (keys sorted, no spaces) and the result shows that exact string: send it byte for byte. A string is… |
| useSandbox | boolean | – | Sign with the sandbox key (default) or the production key; a token signed with one environment's key is refused by the other |
No output schema declared.
No examples provided.
payware_authentication_generate_rsa_keys ~40
[Merchant] Generate RSA key pair for payware API authentication
| Name | Type | Req | Description |
|---|---|---|---|
| keySize | number | – | RSA key size in bits |
No output schema declared.
No examples provided.
payware_authentication_setup_sandbox_auth ~78
[Merchant] Setup sandbox authentication configuration for payware API
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key in PEM format (optional, for validation). Uses environment-specific private key as default. |
No output schema declared.
No examples provided.
payware_authentication_test_jwt ~116
[Merchant] Test JWT token creation process with detailed step-by-step breakdown, showing deterministic JSON serialization, SHA-256 hash calculation, and final JWT structure
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID for JWT creation (defaults to environment) |
| requestPayload | object | – | Sample request payload to demonstrate SHA-256 hash calculation |
| showPrivateKey | boolean | – | Whether to show private key details (for debugging) |
| useSandbox | boolean | – | Use the sandbox key (default) or the production key |
No output schema declared.
No examples provided.
payware_authentication_validate_jwt ~136
[Merchant] Validate and debug a payware JWT: decode header and payload, check the claims against the API's rules (algorithm, audience including the ISV on-behalf form, 5-minute freshness), and verify the contentSha256 hash against the request body when one is given
| Name | Type | Req | Description |
|---|---|---|---|
| expectedPayload | object | – | The request body the token was made for (optional). Give it for POST, PUT and PATCH: contentSha256 is then required and checked against it. Leave it out for GET and DELETE, which carry no hash. |
| jwtToken | string | yes | JWT token to validate and debug |
No output schema declared.
No examples provided.
payware_campaigns_create_campaign ~149
[Merchant] Create a campaign. Attach placements to it by giving its campaignId when you create or replace a placement. **Endpoint:** POST /campaigns (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| endsOn | string | – | Last day, YYYY-MM-DD |
| externalRef | string | – | An agency's own campaign code, up to 100 characters |
| name | string | yes | Campaign name, up to 100 characters |
| startsOn | string | – | First day, YYYY-MM-DD |
| status | string | – | Descriptive only: it does not switch the placements on or off |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_campaigns_delete_campaign ~97
[Merchant] Delete a campaign. Its placements stay, detached from it, and keep working. **Endpoint:** DELETE /campaigns/{campaignId} (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| campaignId | string | yes | The campaign's ID: cp + 8 letters or digits, e.g. cp7e4rCToG |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_campaigns_get_campaign ~90
[Merchant] Get a campaign, with the IDs of its placements you can see. **Endpoint:** GET /campaigns/{campaignId}
| Name | Type | Req | Description |
|---|---|---|---|
| campaignId | string | yes | The campaign's ID: cp + 8 letters or digits, e.g. cp7e4rCToG |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_campaigns_get_campaign_stats ~231
[Merchant] A campaign's results over [from, to): offers shown when a bank resolved one of its placement IDs (resolutions), offers shown after a recognised soundbite tap (recognitions), payments started (transactions) and confirmed, and confirmed amounts by currency. **Endpoint:** GET /campaigns/{campaignId}/stats (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| campaignId | string | yes | The campaign's ID: cp + 8 letters or digits, e.g. cp7e4rCToG |
| from | string | – | Start of the period: a date (YYYY-MM-DD, the start of that day in UTC) or an ISO-8601 instant with an offset, e.g. 2026-10-19T00:00:00+03:00. Default: 30 days before to |
| to | string | – | End of the period, exclusive, in the same forms. Default: now. Any length: impressions are kept for good |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_campaigns_list_campaigns ~125
[Merchant] List the merchant's campaigns. A campaign groups placements, possibly of different products, and reports their combined results. **Endpoint:** GET /campaigns Changing anything here needs the PRM plan, and below it a change answers 403 ERR_UNAUTHORIZED_OPERATION; reading works on every plan, results only on PRM. A merchant that leaves PRM keeps its placements read-only, and a printed placement code then pays as its plain product with no attribution.
| Name | Type | Req | Description |
|---|---|---|---|
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_campaigns_update_campaign ~206
[Merchant] **Replace** a campaign's details. An omitted startsOn, endsOn or externalRef is cleared; an omitted status keeps the current one. Get the campaign first and send every value you want to keep. **Endpoint:** PUT /campaigns/{campaignId} (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| campaignId | string | yes | The campaign's ID: cp + 8 letters or digits, e.g. cp7e4rCToG |
| endsOn | string | – | Last day, YYYY-MM-DD |
| externalRef | string | – | An agency's own campaign code, up to 100 characters |
| name | string | yes | Campaign name, up to 100 characters |
| startsOn | string | – | First day, YYYY-MM-DD |
| status | string | – | Descriptive only: it does not switch the placements on or off |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_data_cancel_export ~96
[Merchant] Cancel a running export process. Only exports in QUEUED status can be cancelled.
| Name | Type | Req | Description |
|---|---|---|---|
| exportId | string | yes | The export ID of the export to cancel (UUID format) |
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses environment-specific private key as default. |
No output schema declared.
No examples provided.
payware_data_cancel_report ~96
[Merchant] Cancel a running report generation. Only reports in QUEUED status can be cancelled.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses environment-specific private key as default. |
| requestId | string | yes | The request ID of the report to cancel (UUID format) |
No output schema declared.
No examples provided.
payware_data_download_export ~203
[Merchant] Download a READY export file (production only). A text export (CSV, HTML, XML) is previewed; with saveToFile the file is written to payware-mcp-downloads in the system temp directory and the result names its path. A binary export (PDF, XLS(X), DOCX, ODT, ODS, RTF) needs saveToFile.
| Name | Type | Req | Description |
|---|---|---|---|
| exportId | string | yes | The export ID from the export request (UUID format) |
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses the production private key as default (reports run on production only). |
| saveToFile | boolean | – | Save the file to payware-mcp-downloads in the system temp directory and return its path. Without it a text export is previewed and a binary one only described. |
No output schema declared.
No examples provided.
payware_data_export_report ~119
[Merchant] Export a READY report in a specific format (PDF, CSV, Excel, JSON). The report must be in READY status first.
| Name | Type | Req | Description |
|---|---|---|---|
| outputFormat | string | – | Export format |
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses production private key as default (Data API is production-only). |
| requestId | string | yes | The request ID from the report generation (UUID format) |
No output schema declared.
No examples provided.
payware_data_generate_report ~476
[Merchant] Generate an asynchronous data report for merchant data analysis and reporting. Production only - not supported in sandbox. ⚠️ **Running a report is entitlement-checked as of 2026-08-22.** Naming a report answers **403 `ERR_REPORT_NOT_AVAILABLE`** when that report is not included in the caller's plan or partner type. Until that date only the *menu* was filtered - the door was not - so a caller that hard-coded a report id it had never been offered could still run it, and may now start failing. **Always resolve the id from `payware_data_list_reports` rather than hard-coding one.** That call and this check share a single rule, so the menu and the door cannot drift apart: if a report is in that list, this call will accept it. Distinguish the two failures: - **403 `ERR_REPORT_NOT_AVAILABLE`** - the report exists, this caller may not run it. Not retryable; it is a plan boundary, not a transient error. - **404 `ERR_REPORT_UNIT_ID_NOT_FOUND`** - no report is registered under that id at all. Usually a typo or a stale id. For an ISV acting on behalf of a merchant, the plan that applies is the **merchant's**, and reports are outside the Basic plan entirely.
| Name | Type | Req | Description |
|---|---|---|---|
| dateFrom | string | – | Start date (YYYY-MM-DD). Optional: defaults to today; the WTD, MTD and YTD reports compute their own start. |
| dateTo | string | – | End date (YYYY-MM-DD). Optional: defaults to today. |
| ignorePagination | boolean | – | If true, return report as single continuous document. If false, paginate results. |
| locale | string | – | Locale for the report |
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses production private key as default (Data API is production-only). |
| reportUnitId | string | yes | The ID of the report to generate |
| timeZone | string | – | Timezone for date calculations (e.g., 'Europe/Sofia', 'America/New_York') |
No output schema declared.
No examples provided.
payware_data_get_export_list ~116
[Merchant] Get all export attempts for a specific report request. Returns list of exports in various formats with their status and download information. Production only - not supported in sandbox.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses production private key as default (Data API is production-only). |
| requestId | string | yes | The request ID (UUID) to get exports for |
No output schema declared.
No examples provided.
payware_data_get_export_status ~96
[Merchant] Get the status of a report export request. Use this to monitor export progress.
| Name | Type | Req | Description |
|---|---|---|---|
| exportId | string | yes | The export ID returned from the export request (UUID format) |
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses environment-specific private key as default. |
No output schema declared.
No examples provided.
payware_data_get_report_requests ~124
[Merchant] Get all execution requests for a specific report type. Returns historical execution records with status and parameters. Production only - not supported in sandbox.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses production private key as default (Data API is production-only). |
| reportId | string | yes | The report id whose runs to list, bare (processedTransactions) or as the path the list returns (/processedTransactions) |
No output schema declared.
No examples provided.
payware_data_get_report_status ~103
[Merchant] Get the status of an asynchronous report generation request. Use this to monitor report progress.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses production private key as default (Data API is production-only). |
| requestId | string | yes | The request ID returned from the report generation request (UUID format) |
No output schema declared.
No examples provided.
payware_data_list_reports ~88
[Merchant] List all available report types with their configurations, descriptions, and visibility settings. Production only - not supported in sandbox.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses production private key as default (Data API is production-only). |
No output schema declared.
No examples provided.
payware_generate_code_example ~435
[Merchant] Generate a complete program for one payware API call, or the JWT helper, in python, nodejs, php, java, csharp, curl. Each program signs its request as payware requires (RS256 JWT with contentSha256 for a body, on behalf of a merchant for an ISV) and calls the real route. finalize_transaction (payment institutions) is the whole institution flow: process, EXECUTING immediately before money moves, then CONFIRMED once the Merchant Leg has completed, or FAILED.
| Name | Type | Req | Description |
|---|---|---|---|
| include_comments | boolean | – | true (default): the program with comments, inside a page that names the route and what to know about it. false: the program alone. |
| include_error_handling | boolean | – | true (default): report a failed status or a network error. false: the shortest program. |
| language | string | – | python (requests, PyJWT), nodejs (axios, jsonwebtoken), php (cURL, firebase/php-jwt), java (Java 11 HttpClient, no dependencies), csharp (.NET 6 HttpClient, no dependencies) or curl (curl and openssl… |
| operation | string | yes | The operation. Transactions: create_transaction, get_transaction_status, process_transaction, cancel_transaction, get_transaction_history, and for payment_institution finalize_transaction (process, E… |
| partner_type | string | – | merchant, isv (calls on behalf of a merchant, and the OAuth2 token endpoints) or payment_institution. Decides which operations exist and how the JWT is signed. Default merchant. |
No output schema declared.
No examples provided.
payware_generate_documentation ~108
[Merchant] An integration overview for one partner type: base URLs, how requests are signed, and every operation payware_generate_code_example can write, with its route.
| Name | Type | Req | Description |
|---|---|---|---|
| language | string | – | The language the overview's next steps refer to: python, nodejs, php, java, csharp, curl. Default python. |
| partner_type | string | – | merchant, isv or payment_institution. Decides the operations listed and how requests are signed. Default merchant. |
No output schema declared.
No examples provided.
payware_logs_download_url ~177
[Merchant] Get download URL for logs archive. Premium plan required. Returns URL for downloading logs as gzipped JSON file.
| Name | Type | Req | Description |
|---|---|---|---|
| from | string | – | Start timestamp in ISO 8601 format (e.g., '2024-01-15T00:00:00Z'). Defaults to 24 hours ago. |
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses environment-specific private key as default. |
| to | string | – | End timestamp in ISO 8601 format (e.g., '2024-01-15T23:59:59Z'). Defaults to now. |
| useSandbox | boolean | – | Read the sandbox logs (default) or production's |
No output schema declared.
No examples provided.
payware_logs_query ~294
[Merchant] Query application logs with filters. Premium plan required. Returns paginated JSON log entries for debugging and monitoring your integration.
| Name | Type | Req | Description |
|---|---|---|---|
| cursor | string | – | Pagination cursor from previous response for fetching next page. |
| from | string | – | Start timestamp in ISO 8601 format (e.g., '2024-01-15T00:00:00Z'). Defaults to 24 hours ago. |
| level | string | – | Filter by log level, an exact match: WARN returns WARN lines only, not ERROR as well (LogAccessService compares the level for equality). |
| limit | number | – | Maximum records to return (default 1000, max 10000). |
| logger | string | – | Filter by logger name (partial match). E.g., 'TransactionController' to see transaction-related logs. |
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses environment-specific private key as default. |
| search | string | – | Search text in log messages. Case-insensitive partial match. |
| to | string | – | End timestamp in ISO 8601 format (e.g., '2024-01-15T23:59:59Z'). Defaults to now. |
| useSandbox | boolean | – | Read the sandbox logs (default) or production's |
No output schema declared.
No examples provided.
payware_logs_status ~101
[Merchant] Get log availability and storage information. Premium plan required. Shows if logs are available, total size, and file count.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for authentication. Uses environment-specific private key as default. |
| useSandbox | boolean | – | Read the sandbox logs (default) or production's |
No output schema declared.
No examples provided.
payware_operations_cancel_transaction ~179
[Merchant] Cancel an ACTIVE transaction created by this merchant. Only the merchant who created the transaction can cancel it, and only before it has been processed.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Can use PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for JWT token creation. Can use PAYWARE_PRIVATE_KEY_PATH env var as default. |
| statusMessage | string | yes | Reason for cancellation (required) |
| transactionId | string | yes | Transaction ID to cancel (must be an ACTIVE 'pw' transaction created by this merchant). Format: 'pw' + 8 characters. Product ('pr') and soundbite ('ps') ids are NOT cancellable - deactivate those thr… |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_operations_create_transaction ~2,227
[Merchant] Create a new payware transaction. Parameters map to the following API structure: 📋 **ROOT LEVEL** (Transaction metadata): - shop, account, friendlyName, callbackUrl, passbackParams - producerPartnerId, terminalId, terminalManufacturer (POS terminal producer attribution - see below) 💰 **TRANSACTION DATA** (trData object): - amount, currency, reasonL1, reasonL2 ⚙️ **TRANSACTION OPTIONS** (trOptions object): - type, timeToLive, deferredAllowed (deferred Merchant Leg opt-in - see below) 📱 **QR OPTIONS** (qrOptions object - only when type=QR): - qrFormat, qrBorder, qrErrorCorrection, qrScale, qrVersion 🔗 **BARCODE OPTIONS** (barOptions object - only when type=BARCODE): - barFormat, barModuleWidth, barBarHeight, barFontSize, barHumanReadableLocation 🔐 **AUTHENTICATION** (not sent to API, used for JWT signing): - partnerId, privateKey **Actual API Request Structure:** ```json { "shop": "...", "account": "...", "friendlyName": "...", "callbackUrl": "...", "passbackParams": "...", "trData": { "amount": "25.50", "currency": "EUR", "reasonL1": "...", "reasonL2": "..." }, "trOptions": { "type": "QR", "timeToLive": 300 }, "qrOptions": { ... } } ``` ⏳ **DEFERRED MERCHANT LEG** (optional, `trOptions.deferredAllowed`) By default the payer's institution pays this transaction with an instant or an internal transfer. `deferredAllowed: true` also lets it use an ordinary credit transfer that settles later. Rules: - Honoured only on your own call without POS terminal producer fields. With `producerPartnerId`, `terminalId` or `terminalManufacturer` the transaction is refused with 400 `ERR_DEFERRED_TRANSFER_NOT_ALLOWED`: a till payment stays instant or internal. - **A deferred payment stays ACTIVE, i.e. pending, until the transfer settles, which can take days**, and so can stay ACTIVE past its `timeToLive`. Keep polling or wait for the callback; never treat it as expired yourself. CONFIRMED arrives once the mon…
| Name | Type | Req | Description |
|---|---|---|---|
| account | string | – | 📋 ROOT LEVEL: Account identifier (if not supplied, determined from payware portal) |
| amount | number | – | Amount as currency value (e.g., 25.50 for €25.50 or '15.75' for $15.75). Can be 0 for amount-flexible transactions. Max 36 chars including decimals |
| barBarHeight | number | – | BARCODE OPTIONS (type=BARCODE): bar height in pixels, 15-1000 (default 100) |
| barFontSize | number | – | BARCODE OPTIONS (type=BARCODE): font size of the human-readable text, 0-24 (default 12) |
| barFormat | string | – | BARCODE OPTIONS (type=BARCODE): image format, PNG, JPG or SVG (default SVG) |
| barHumanReadableLocation | string | – | BARCODE OPTIONS (type=BARCODE): where the human-readable text goes (default NONE) |
| barModuleWidth | number | – | BARCODE OPTIONS (type=BARCODE): module width in pixels, 1-10 (default 2) |
| callbackUrl | string | – | 📋 ROOT LEVEL: HTTPS URL to receive transaction status callbacks. Must be https://, must present a publicly-trusted TLS certificate, and must resolve to a public address - internal/private addresses… |
| currency | string | yes | Transaction currency (ISO 3-character code) |
| deferredAllowed | boolean | – | ⚙️ TRANSACTION OPTIONS: Opt this transaction in to a deferred Merchant Leg (sent as trOptions.deferredAllowed). Optional; omit it for instant or internal only. When true, the payer's institution may… |
| friendlyName | string | – | 📋 ROOT LEVEL: Account holder recognizable name (if not supplied, merchant alias is used) |
| idempotencyKey | string | – | Optional. Sent as the Idempotency-Key header. Use one value per payment (a UUID is typical) and the same value on every retry of it: a retry with the same key and body within 24 hours returns the tra… |
| partnerId | string | – | 🔐 AUTHENTICATION: Partner ID from payware dashboard (not sent in API request). Uses PAYWARE_PARTNER_ID env var as default. |
| passbackParams | string | – | 📋 ROOT LEVEL: Additional parameters passed back in callbacks (max 200 chars) |
| privateKey | string | – | 🔐 AUTHENTICATION: RSA private key for JWT token creation (not sent in API request). Accepts PEM format with/without headers or raw base64 content. Uses environment-specific private key as default. |
| producerPartnerId | string | – | 🏭 ROOT LEVEL: partnerId of the POS terminal producer whose terminal produced this transaction. Must be a partner registered with payware and flagged as a producer - an unrecognised value REJECTS the… |
| qrBorder | number | – | QR OPTIONS (type=QR): quiet zone around the code, in modules, 1-10 (default 4) |
| qrErrorCorrection | string | – | QR OPTIONS (type=QR): error correction, LOW (7%), MEDIUM (15%), QUARTILE (25%) or HIGH (30%) (default QUARTILE) |
| qrFormat | string | – | QR OPTIONS (type=QR): image format, PNG, JPG or SVG (default SVG) |
| qrScale | number | – | QR OPTIONS (type=QR): pixels per module, 1-100, irrelevant for SVG (default 16) |
| qrVersion | number | – | QR OPTIONS (type=QR): QR version, 1-40, higher holds more data (default 3) |
| reasonL1 | string | yes | Transaction grounds description (required) |
| reasonL2 | string | – | Transaction grounds description continuation (optional) |
| shop | string | – | 📋 ROOT LEVEL: Shop code (if not supplied, default shop is used) |
| terminalId | string | – | 🏭 ROOT LEVEL: Opaque identifier of the physical terminal, scoped to the producer's own estate. payware assumes no format and enforces no uniqueness; it is recorded for provenance and never affects a… |
| terminalManufacturer | string | – | 🏭 ROOT LEVEL: Device manufacturer as reported by the terminal. Recorded for provenance; a mismatch against the expected producer is surfaced in settlement review and never blocks the transaction. No… |
| timeToLive | number | – | ⚙️ TRANSACTION OPTIONS: Time allowed for payment initiation in seconds. Once the payer's institution has started the payment, the transaction stays ACTIVE past it until the money has moved (seconds f… |
| type | string | – | Transaction type |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_operations_get_transaction_history ~540
[Merchant] Get history of completed/finalized transactions with final statuses. **Endpoint:** GET /transactions-history/{transactionId} **Use Case:** Retrieve transactions with final statuses: CONFIRMED, DECLINED, FAILED, EXPIRED, CANCELLED. **Note:** For ACTIVE transactions, use 'payware_operations_get_transaction_status' instead. 📦 **This is where the delivery address lives.** For a SHIPPABLE transaction, `deliveryAddress` (fullName, streetAddressLine1/2, zipCode, city, region, country, phoneNumber, email) is returned here and **only** here. It was removed from the finalized callback on 2026-08-07: a callback is delivered to whatever certificate the merchant's endpoint happens to present, which is an acceptable trade for a transaction id and an amount and not one for a shopper's home address. This endpoint is JWT-authenticated, tenant-scoped and runs over a verified channel. So the pattern is: the callback tells you the shipment is ready, and this call gives you the address to ship to. ⚠️ **Requires Standard or Premium.** This endpoint was ungated until 2026-08-21 and is now on the same plan gate as the rest of the transaction surface, so a **Basic** merchant - or an ISV acting on behalf of one - now gets **403**. If reading history started failing without a code change, this is why. Financial institutions are unaffected; banks are always Premium. ⏱️ **Rate limited, like every payware endpoint.** A 429 carries `ERR_RATE_LIMIT_EXCEEDED` and a `Retry-After` header, in seconds; the request was not processed, so the identical request is safe to retry once the window passes. The failure result exposes this as `error.throttled`, `error.retryable` and `error.retryAfterSeconds`.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Can use PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for JWT token creation. Can use PAYWARE_PRIVATE_KEY_PATH env var as default. |
| transactionId | string | yes | The pw transaction id. History looks the id up as given, so a product, placement, soundbite or POI id is not found: use the pw id the process response returned. Up to 32 characters (identifiers may g… |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_operations_get_transaction_status ~960
[Merchant] Get status of an ACTIVE transaction by ID (for completed/expired transactions use transaction history tool). **Endpoint:** GET /transactions/{transactionId} **Use Case:** Check status of ACTIVE transactions only. This endpoint only returns transactions with ACTIVE status. **Note:** For transactions with final statuses (CONFIRMED, DECLINED, FAILED, EXPIRED, CANCELLED), use 'payware_operations_get_transaction_history' instead. ⏳ **ACTIVE can outlast `timeToLive`. Never infer EXPIRED from the clock.** Once the payer's institution has started the payment (it locks the transaction immediately before the money moves, which you do not see), the transaction stays ACTIVE past `timeToLive` until the money has moved: seconds for an instant or internal transfer, days for a deferred one (a transaction created with `deferredAllowed: true`). Its `timeToLive` then stops at the value it had when the payment started. Keep polling, or wait for the callback: a transaction is EXPIRED only when payware says so, in the callback or in transaction history, and one that is no longer returned here has a final status there. 🛍️ **Product-originated transactions carry a nested `product` object.** Since 2026-07-22 the presentation fields are grouped under `product` rather than sitting flat on the response - the old top-level `imageUrl` is gone. Discriminate a product-originated transaction by the **presence of the object**, not by probing individual fields: ```json { "transactionId": "pw7e4rCToG", "amount": "57.60", "currency": "EUR", "product": { "productId": "pr7e4rCToG", "type": "ITEM", "name": "Cotton T-shirt, black", "shortDescription": "...", "longDescription": "...", "imageUrl": "https://...", "imageDigest": "9f86d081...", "imageContentType": "image/png", "imageBytes": 20480, "termsUrl": "https://...", "termsText": "...", "regularPrice": "63.36", "shippable": false, "quickPay": true, "shopName": "My shop" } } ``…
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Partner ID from payware dashboard. Can use PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for JWT token creation. Can use PAYWARE_PRIVATE_KEY_PATH env var as default. |
| transactionId | string | yes | Transaction ID to check status for |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_operations_process_transaction ~627
[Merchant] Process a PEER transaction (for merchants accepting payments by scanning customer QR/barcode). **Use Case:** Merchant scans customer's payware QR code or barcode to accept payment. **Note:** Only PEER transactions (created by customers) can be processed by merchants. **Flow:** Customer creates transaction → Merchant scans QR/barcode → Merchant processes transaction **API Request Structure:** ```json { "shop": "...", "account": "...", "friendlyName": "...", "callbackUrl": "...", "passbackParams": "...", "trData": { "amount": "25.50", // REQUIRED for processing "currency": "EUR", // REQUIRED for processing "reasonL1": "...", // REQUIRED for processing "reasonL2": "..." }, "trOptions": { "timeToLive": 300 // Overwrites original transaction TTL } } ```
| Name | Type | Req | Description |
|---|---|---|---|
| account | string | – | Account identifier (optional - uses default if not provided) |
| amount | number|string | yes | Amount as currency value to process (e.g., 25.50 for €25.50). Must be positive |
| callbackUrl | string | – | URL to receive transaction status callbacks |
| currency | string | yes | Transaction currency (ISO 3-character code) |
| friendlyName | string | – | Account holder recognizable name (optional) |
| idempotencyKey | string | – | Optional. Sent as the Idempotency-Key header. Use one value per payment (a UUID is typical) and the same value on every retry of it: a retry with the same key and body within 24 hours returns the tra… |
| partnerId | string | – | Partner ID from payware dashboard. Can use PAYWARE_PARTNER_ID env var as default. |
| passbackParams | string | – | Parameters passed back through callback |
| privateKey | string | – | RSA private key for JWT token creation. Can use PAYWARE_PRIVATE_KEY_PATH env var as default. |
| reasonL1 | string | yes | Transaction grounds description (required) |
| reasonL2 | string | – | Transaction grounds description continuation (optional) |
| shop | string | – | Shop code (optional - uses default if not provided) |
| timeToLive | number | – | Time allowed for transaction processing in seconds |
| transactionId | string | yes | Transaction ID to process: 'pw' (standard), 'pr' (product), 'pl' (placement: pays as its product, and the payment is attributed to the placement), 'ps' (soundbite). Up to 32 characters (identifiers m… |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_operations_simulate_callback ~878
[Merchant] Simulate callback scenarios for testing webhook handling. Generates the payload a merchant's `callbackUrl` actually receives, so a handler can be built and tested against the real shape. Four properties of that shape are easy to get wrong: **1. Absent means absent, not zero.** The payload omits properties with no value rather than sending `null` or `0`. `statusMessage`, `passbackParams`, `fee`, `feeFixed` and `feeRate` are all simply missing when they do not apply. A missing `fee` means the fee is *unknown* for that transaction - it does not mean the transaction was free. Do not write a handler that reads `payload.fee` as a number without checking it is there. **2. `finalized` is absent on EXPIRED.** An expired transaction is closed by the platform's expiry sweep, which sets no finalization moment. Every other status carries one. **3. `EXPIRED` is a non-payment, not a failure.** The payer never paid within `timeToLive`. Release the order or the stock, as you would for a cancellation - do not treat it as an error to retry. **4. Deduplicate on `(transactionId, callbackType)`.** payware retries a callback up to 15 times, backing off from about a second to at most 5 minutes between attempts, until the endpoint answers any 2xx. That pair is stable across every retry of the same event, and it is the key payware guarantees. A handler that does not deduplicate will eventually process one payment twice. **Not on this payload:** `deliveryAddress` (removed 2026-08-07 - fetch it from `payware_operations_get_transaction_history`, which is authenticated and tenant-scoped), `producerPartnerId`, `transactionType` and `initiatedBy` (the last two are carried on TRANSACTION_PROCESSED, which merchants do not receive).
| Name | Type | Req | Description |
|---|---|---|---|
| amount | string | – | Transaction amount (e.g., '57.60') |
| callbackUrl | string | – | URL where callback would be sent (for simulation only) |
| currency | string | – | Transaction currency |
| fee | string | – | payware's fee on this transaction plus VAT where it applies, at the currency's smallest payable unit (e.g. '0.29'). The payer's institution transfers it to payware alongside the merchant's payment, a… |
| feeFixed | string | – | Fixed fee component of the applicable fee configuration, e.g. '0.1000'. Informational, for reconciliation. Present on FINALIZED callbacks since 2026-08-21 - before that a merchant got the total fee b… |
| feeRate | string | – | Variable rate of the applicable fee configuration, e.g. '0.0150' = 1.5%. Informational, same as feeFixed. Pass null to model a transaction with no fee configuration. |
| feeVat | string | – | The VAT included in fee (fee minus feeVat is payware's fee excluding VAT), at the same scale; zero when no VAT applies (reverse charge, or a merchant outside the EU). Present exactly when fee is (ser… |
| paymentMethod | string | – | Payment method chosen by customer. A2A = direct transfer. CARD_FUNDED = card-linked account. BNPL = buy now pay later. INSTANT_CREDIT = credit line. |
| poiId | string | – | Set to simulate a POI sale: the callback then carries the poiId of the POI that created the transaction |
| status | string | – | Transaction status to simulate |
| statusMessage | string | – | Custom status message for the transaction callback |
| transactionId | string | yes | Transaction ID to simulate callback for |
No output schema declared.
No examples provided.
payware_poi_cancel_price ~230
[Merchant] Cancel a pending price on a POI, resetting it to IDLE state. **Authentication:** your own JWT (an ISV makes the same call on your behalf). **Endpoint:** DELETE /poi/{poiId}/price **Use Case:** Cancel a price that was set but not yet scanned (e.g., order cancelled). The POI returns to IDLE and is ready for a new price. **Only before the scan.** The scan is the customer's bank processing the payment, so from then on a POI sale cannot be cancelled by the merchant or an ISV, on any plan: this answers 409 ERR_POI_NO_PENDING_PAYMENT, and cancelling the transaction itself answers 409 ERR_ALREADY_PROCESSED. The sale completes or expires; the POI accepts the next price meanwhile. **Required:** POI ID.
| Name | Type | Req | Description |
|---|---|---|---|
| poiId | string | yes | The POI identifier (format: pi + 8 alphanumeric chars, e.g., piABC12345) |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_poi_create ~492
[Merchant] Create a single POI (Point of Interaction) - a physical payment point a payer scans. **Endpoint:** POST /poi -> 201 Created **A POI belongs to a shop, and a shop belongs to a merchant.** `shopCode` is required - use `payware_shops_list` to find one rather than guessing. Banks do not own POIs; a financial-institution principal gets 403 on every POI endpoint, not an empty result. **`ttlSeconds` is the price-session TTL, not the POI's lifetime.** It bounds how long a price set on this POI stays claimable before the POI returns to IDLE. Range 60-600 seconds; the server defaults it to 300. **Creating many at once?** Use `payware_poi_create_batch` instead. It creates up to 50 in one atomic call, which is both faster and safer than a loop over this tool: a loop that fails halfway leaves a half-built estate with no record of where it stopped.
| Name | Type | Req | Description |
|---|---|---|---|
| callbackUrl | string | – | HTTPS URL for this POI's callbacks: poi.scanned (with the new transaction id), poi.expired (price not scanned) and the sale's TRANSACTION_FINALIZED (final status, with poiId). Signed by the ISV that… |
| name | string | – | Human-readable POI name, e.g. "Till 3" or "Gate B". Shown in the portal and in POI listings. |
| partnerId | string | – | Partner ID from the payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| privateKey | string | – | RSA private key for JWT signing. Uses the environment-specific key as default. |
| shopCode | string | yes | Code of the shop this POI belongs to. Required. Find one with payware_shops_list. |
| ttlSeconds | integer | – | Price-session TTL in seconds - how long a price set on this POI stays claimable before it returns to IDLE. Server default 300. |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_poi_create_batch ~578
[Merchant] Create up to 50 POIs in a single **atomic** call - the tool for rolling out a terminal estate. **Endpoint:** POST /poi/batch -> 201 Created, returning `{ created, pois: [...] }` **Atomic means all or nothing.** Either every entry is created or none is. That is the reason to prefer this over a loop of `payware_poi_create`: a loop that fails on entry 27 leaves 26 POIs behind with nothing recording where it stopped, and re-running it duplicates them. **A POI belongs to a shop, and a shop belongs to a merchant.** `shopCode` is required - use `payware_shops_list` to find one rather than guessing. Banks do not own POIs; a financial-institution principal gets 403 on every POI endpoint, not an empty result. **`ttlSeconds` is the price-session TTL, not the POI's lifetime.** It bounds how long a price set on this POI stays claimable before the POI returns to IDLE. Range 60-600 seconds; the server defaults it to 300. **Defaults and overrides.** `shopCode`, `ttlSeconds` and `callbackUrl` at the top level apply to every entry. An entry may override `name`, `ttlSeconds` and `callbackUrl` for itself. `shopCode` is top-level only - one batch builds one shop. **Limits:** 1 to 50 entries. An empty list is `ERR_BATCH_EMPTY`; more than 50 is `ERR_BATCH_TOO_LARGE`. Both are refused locally before the request is sent. For a larger rollout, split it into batches of 50 - each batch is atomic on its own, so record which batches succeeded.
| Name | Type | Req | Description |
|---|---|---|---|
| callbackUrl | string | – | Default HTTPS callback URL for every POI in the batch. |
| partnerId | string | – | Partner ID from the payware dashboard. Uses PAYWARE_PARTNER_ID env var as default. |
| pois | array | yes | The POIs to create. Each entry may set name, ttlSeconds and callbackUrl; anything omitted falls back to the top-level value. An entry may be an empty object, which creates an unnamed POI with the bat… |
| privateKey | string | – | RSA private key for JWT signing. Uses the environment-specific key as default. |
| shopCode | string | yes | Code of the shop every POI in this batch belongs to. Required, top-level only. Find one with payware_shops_list. |
| ttlSeconds | integer | – | Default price-session TTL for every POI in the batch. Server default 300. |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_poi_get ~122
[Merchant] Get details of a specific POI (Point of Interaction). **Authentication:** your own JWT (an ISV makes the same call on your behalf). **Endpoint:** GET /poi/{poiId} **Use Case:** Retrieve full details of a physical payment point including configuration and current state. **Required:** POI ID.
| Name | Type | Req | Description |
|---|---|---|---|
| poiId | string | yes | The POI identifier (format: pi + 8 alphanumeric chars, e.g., piABC12345) |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_poi_get_qrcode ~155
[Merchant] Generate a QR code image for a POI that customers can scan. **Endpoint:** GET /poi/{poiId}/image **Authentication:** your own JWT **Use Case:** Generate QR codes for printing or displaying on screens. **Formats:** PNG (default), SVG, JPG Returns the image itself (MCP image content); an SVG comes back as its markup. **Required:** POI ID.
| Name | Type | Req | Description |
|---|---|---|---|
| format | string | – | Image format (default: PNG) |
| poiId | string | yes | The POI identifier (format: pi + 8 alphanumeric chars, e.g., piABC12345) |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_poi_get_status ~378
[Merchant] Get the current status of a POI and the outcome of its sales. **Authentication:** your own JWT (an ISV makes the same call on your behalf). **Endpoint:** GET /poi/{poiId}/status[?sessionToken=...] **Use Case:** Follow a sale to its outcome - the backup to callbacks, and on Basic (no transaction endpoints) the only way when a callback is lost or there is no backend. **POI States:** - IDLE: no pending price and no sale running - READY: price set, waiting for a scan (wins over BUSY: the POI can take the next price while a sale runs) - BUSY: a customer scanned and the sale is running **Every response** carries lastTransactionId / lastTransactionStatus - the POI's most recent sale, running (ACTIVE) or finished (CONFIRMED, DECLINED, FAILED, CANCELLED, EXPIRED). Once the POI is back to IDLE, lastTransactionStatus is how the last sale ended. **With sessionToken** (from payware_poi_set_price) the response also carries transactionId / transactionStatus for exactly that sale - use it when the POI may be re-armed before the previous sale finishes. Poll every 2-3 seconds and stop at a final status; the read is rate limited. **Required:** POI ID.
| Name | Type | Req | Description |
|---|---|---|---|
| poiId | string | yes | The POI identifier (format: pi + 8 alphanumeric chars, e.g., piABC12345) |
| sessionToken | string | – | Optional. The sessionToken returned by payware_poi_set_price; returns that sale's transaction and status |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_poi_list ~127
[Merchant] List all POIs (Points of Interaction) for a merchant. **Authentication:** your own JWT (an ISV makes the same call on your behalf). **Endpoint:** GET /poi **Use Case:** Retrieve all physical payment points configured for a merchant. POI states: IDLE (no price, no sale running), READY (price set, waiting for a scan), BUSY (scanned, sale running). A disabled POI is not a state: it shows isActive false.
| Name | Type | Req | Description |
|---|---|---|---|
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_poi_set_price ~335
[Merchant] Set a pending price on a POI for customer payment. **Authentication:** your own JWT (an ISV makes the same call on your behalf). **Endpoint:** PUT /poi/{poiId}/price **Use Case:** Set the amount a customer should pay when they scan the POI. The POI moves to READY and waits for a scan until the TTL expires. The scan creates the transaction and the POI is BUSY until the sale is final. **Only amount, currency and ttlSeconds are accepted.** There is no description, callback URL or passback field on a price - the callback URL is set on the POI when it is created, and a POI without one sends no callbacks. **Keep the returned sessionToken** until the sale has a final status: pass it to payware_poi_get_status to read that sale's transaction and outcome. **Required:** POI ID, amount, currency.
| Name | Type | Req | Description |
|---|---|---|---|
| amount | string | yes | Payment amount (e.g., '25.50'), positive and no finer than the currency's smallest unit |
| currency | string | yes | ISO 4217 currency code (e.g., 'EUR', 'USD', 'GBP') |
| poiId | string | yes | The POI identifier (format: pi + 8 alphanumeric chars, e.g., piABC12345) |
| ttlSeconds | integer | – | Seconds until the price expires if nobody scans it (60-600). Defaults to the POI's own ttlSeconds. |
| useSandbox | boolean | – | Use sandbox environment for testing |
No output schema declared.
No examples provided.
payware_products_create_airing ~463
[Merchant] Add an airing rule to a placement: up to 100 rules per placement. Example: "daily 08:00-08:30 and 15:40-16:10" is one DAILY rule with two windows. Check `warnings` in the response: AIRING_OVERLAP means another soundbite placement of the same product airs at the same time in an overlapping region, and a tap then is attributed to neither. **Endpoint:** POST /products/{productId}/placements/{placementId}/airings (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| daysOfWeek | array | – | WEEKLY: the days it airs on |
| endDate | string | – | Last day, YYYY-MM-DD, at most 366 days after startDate. Omit for open-ended |
| excludedDates | array | – | Days it does not air, YYYY-MM-DD |
| expectedAudience | integer | – | Expected audience per airing, for your own planning |
| frequency | string | yes | How the rule repeats |
| monthDays | array | – | MONTHLY by date: days of the month. A day a month lacks is skipped |
| monthWeek | integer | – | MONTHLY by weekday: which week, -1 for the last. Use with monthWeekday |
| monthWeekday | string | – | MONTHLY by weekday: the weekday |
| placementId | string | yes | The placement's ID: pl + 8 letters or digits, e.g. pl7e4rCToG |
| productId | string | yes | The product's ID: pr + 8 letters or digits, e.g. pr7e4rCToG |
| repeatEvery | integer | – | Every N days, weeks or months. Default 1 |
| startDate | string | yes | First day, YYYY-MM-DD, in the rule's time zone |
| timeZone | string | – | IANA time zone, e.g. Europe/Sofia. Default: the product's |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
| windows | array | yes | Time windows on each day it airs, local to the time zone: 1 to 24, each up to 6 hours |
No output schema declared.
No examples provided.
payware_products_create_placement ~463
[Merchant] Create a placement for a product; a product has no limit on its placements. The response carries its placementId, which goes on the medium wherever the product ID would: a QR code (its payware link, or payware:{placementId}), an NFC tag, a BLE beacon, a link, a barcode or an SMS. A bank resolving it pays for the product, and the payment is attributed to the placement. For a SOUNDBITE carrier, add airing rules so taps during the airing are attributed. **Endpoint:** POST /products/{productId}/placements (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| active | boolean | – | Whether it is in use. Governs airing and soundbite attribution; a printed code keeps resolving until the placement is deleted |
| activeFrom | string | – | Start of its active window, ISO-8601 with an offset. Empty means the product's |
| activeTo | string | – | End of its active window, ISO-8601 with an offset. Empty means the product's |
| campaignId | string | – | The campaign it belongs to, if any (cp + 8 characters) |
| carriers | array | yes | The methods that carry the placement ID to a payer. SOUNDBITE airs the product's audio and needs airing rules |
| channel | string | – | Descriptive, e.g. the TV channel or the website, up to 100 characters |
| externalRef | string | – | An agency's own code, up to 100 characters |
| location | string | – | Descriptive, e.g. the venue or the address, up to 255 characters |
| medium | string | yes | What the placement is |
| name | string | yes | Placement name, up to 100 characters, e.g. "Sofia metro posters, October" |
| productId | string | yes | The product's ID: pr + 8 letters or digits, e.g. pr7e4rCToG |
| regions | array | – | ISO 3166-1 alpha-2 codes of the countries it airs in, matched against the paying bank's country. Empty means anywhere |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_products_create_product ~518
[Merchant] Create a new product for inventory management and payment processing. **Product Structure:** 📦 **PRODUCT METADATA**: name, shortDescription, longDescription, sku, upc, shippable, active, shop 💰 **PRODUCT DATA** (prData object): type, regularPrice, currency, overlapPriority, timeToLive, activeFrom, activeTo, timeZone ⚙️ **PRODUCT OPTIONS** (prOptions object): imageUrl, termsUrl, termsText **Required:** name **Optional:** All other parameters have sensible defaults
| Name | Type | Req | Description |
|---|---|---|---|
| active | string | – | Indicates if product can serve as payment source |
| activeFrom | string | – | Product active state starting date (YYYY-MM-DD format) |
| activeTo | string | – | Product active state ending date (YYYY-MM-DD format) |
| currency | string | – | Price currency (3-character ISO code) |
| imageUrl | string | – | URL pointing to external product image resource |
| longDescription | string | – | Long product description |
| name | string | yes | Product recognizable name (required) |
| overlapPriority | string | – | Priority when overlapping price schedules exist |
| partnerId | string | – | Merchant partner ID (uses PAYWARE_PARTNER_ID env var as default) |
| privateKey | string | – | RSA private key for authentication (uses environment-specific private key as default) |
| productType | string | – | Type of product |
| regularPrice | string | – | Product regular price as a decimal string. Zero or positive, at most 12 integer digits, and no more decimals than the currency's minor unit (0 for JPY, 2 for EUR, 3 for KWD, 8 for BTC). Returned as a… |
| shippable | string | – | Indicates if product requires delivery address |
| shop | string | – | Shop code (if not supplied, default shop is used) |
| shortDescription | string | – | Short product description |
| sku | string | – | Stock Keeping Unit (SKU) |
| termsText | string | – | Terms and conditions text |
| termsUrl | string | – | URL pointing to external terms and conditions resource |
| timeToLive | number | – | Time allowed for product payment in seconds (60-2592000) |
| timeZone | string | – | Product state scheduling timezone (IANA format, e.g., 'Europe/Sofia') |
| upc | string | – | Universal Product Code (UPC) |
| useSandbox | boolean | – | Use sandbox environment |
No output schema declared.
No examples provided.
payware_products_create_schedule ~205
[Merchant] Create a price schedule for a product to manage time-based pricing. Premium (PRM) plan only: the server answers 403 on any other plan (for an ISV, the merchant's plan).
| Name | Type | Req | Description |
|---|---|---|---|
| correctionType | string | – | Price correction method |
| correctionValue | string | – | Correction value (positive number with max 2 decimals) |
| dateFrom | string | – | Schedule start date (YYYY-MM-DD format) |
| dateTo | string | – | Schedule end date (YYYY-MM-DD format) |
| description | string | – | Schedule description |
| partnerId | string | – | Merchant partner ID (uses PAYWARE_PARTNER_ID env var as default) |
| priceCorrection | string | – | Price correction direction |
| privateKey | string | – | RSA private key for authentication (uses environment-specific private key as default) |
| productId | string | yes | Product identifier (starts with 'pr') |
| useSandbox | boolean | – | Use sandbox environment |
No output schema declared.
No examples provided.
payware_products_delete_airing ~149
[Merchant] Delete one airing rule. **Endpoint:** DELETE /products/{productId}/placements/{placementId}/airings/{ruleId} (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| placementId | string | yes | The placement's ID: pl + 8 letters or digits, e.g. pl7e4rCToG |
| productId | string | yes | The product's ID: pr + 8 letters or digits, e.g. pr7e4rCToG |
| ruleId | integer | yes | The airing rule's ID, from payware_products_list_airings |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_products_delete_audio ~135
[Merchant] Delete an audio file from a product. This action cannot be undone. Premium (PRM) plan only: the server answers 403 on any other plan (for an ISV, the merchant's plan).
| Name | Type | Req | Description |
|---|---|---|---|
| audioId | number | yes | Audio identifier |
| partnerId | string | – | Merchant partner ID (uses PAYWARE_PARTNER_ID env var as default) |
| privateKey | string | – | RSA private key for authentication (uses environment-specific private key as default) |
| productId | string | yes | Product identifier (starts with 'pr') |
| useSandbox | boolean | – | Use sandbox environment |
No output schema declared.
No examples provided.
payware_products_delete_placement ~158
[Merchant] Delete a placement. **Its printed codes and its payware link stop resolving**, and its ID is never reused. To stop airing and attribution but keep printed codes working, replace it with active false instead. **Endpoint:** DELETE /products/{productId}/placements/{placementId} (PRM plan)
| Name | Type | Req | Description |
|---|---|---|---|
| placementId | string | yes | The placement's ID: pl + 8 letters or digits, e.g. pl7e4rCToG |
| productId | string | yes | The product's ID: pr + 8 letters or digits, e.g. pr7e4rCToG |
| useSandbox | boolean | – | Use the sandbox (the default) rather than production |
No output schema declared.
No examples provided.
payware_products_delete_product ~99
[Merchant] Delete a product from the merchant account. This action cannot be undone.
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Merchant partner ID (uses PAYWARE_PARTNER_ID env var as default) |
| privateKey | string | – | RSA private key for authentication (uses environment-specific private key as default) |
| productId | string | yes | Product identifier to delete (starts with 'pr') |
| useSandbox | boolean | – | Use sandbox environment |
No output schema declared.
No examples provided.
payware_products_delete_schedule ~132
[Merchant] Delete a price schedule. This action cannot be undone. Premium (PRM) plan only: the server answers 403 on any other plan (for an ISV, the merchant's plan).
| Name | Type | Req | Description |
|---|---|---|---|
| partnerId | string | – | Merchant partner ID (uses PAYWARE_PARTNER_ID env var as default) |
| privateKey | string | – | RSA private key for authentication (uses environment-specific private key as default) |
| productId | string | yes | Product identifier (starts with 'pr') |
| scheduleId | number | yes | Schedule identifier |
| useSandbox | boolean | – | Use sandbox environment |
No output schema declared.
No examples provided.
How do I install the payware MCP server?
payware runs locally as an npm package, launched with npx -y @payware/mcp-server. Ready-made configuration for Claude, Cursor, VS Code, Codex and 5 more is on this page, copied from each client's own documentation.
npm · @payware/mcp-server
claude mcp add payware-mcp-server -- npx -y @payware/mcp-server
What is the payware MCP server?
payware is an MCP server listed in the public MCP registry as io.github.payware/mcp-server. payware A2A payments API for merchants, ISVs and payment institutions. This page covers its npm package (@payware/mcp-server).
Is the payware MCP server safe to use?
payware scores 80 out of 100 on VerifyMCP. We found no known CVEs affecting it as of 15 November 2026. It declares no install or post-install scripts. That is a record of what we were able to check automatically, not an endorsement. The category breakdown on this page shows every signal behind the number, including the ones we could not confirm.
What tools does the payware MCP server expose?
payware exposes 75 tools: payware_authentication_generate_rsa_keys, payware_authentication_create_jwt_token, payware_authentication_validate_jwt, payware_authentication_test_jwt, payware_authentication_setup_sandbox_auth, and 70 more. Their descriptions and schemas cost roughly 19,669 tokens of context every time the server is loaded.
Is the payware MCP server still maintained?
payware is still listed as active in the MCP registry. We last reached this channel on 15 November 2026. Those dates come from our own scans of the registry and the channel itself, not from anything the publisher announced.
What licence is the payware MCP server under?
payware declares the MIT licence, which is OSI-approved. That covers the source only, and says nothing about the cost of any service it calls.
What did VerifyMCP test on the payware MCP server?
VerifyMCP ran 16 checks on payware, covering Malware scan, Known CVEs, Install scripts, Dependency health and 12 more. Endpoint Security and Transport & Reachability do not apply to an npm package, so they were not tested. The score does not measure everything, and the scoring documentation lists what it leaves out.