payware

Get all execution requests for a specific report type. Returns historical execution records with status and parameters. Production only - not supported in sandbox.

Get the status of an asynchronous report generation request. Use this to monitor report progress.

List all available report types with their configurations, descriptions, and visibility settings. Production only - not supported in sandbox.

Generate production-ready payware API integration code examples with authentication, error handling, and environment configuration for any operation across 16 supported operations and 6 programming languages.

Generate comprehensive documentation for payware API integration with quick start instructions, authentication flows, operation examples, error handling patterns, and language-specific integration guides.

Cancel a PENDING invitation. **The link stops working immediately.** **Endpoint:** DELETE /isv/invitations/{invitationId} -> 204 No Content **Only PENDING invitations can be cancelled.** A COMPLETED, EXPIRED or already-CANCELLED one answers **409** - and for a COMPLETED one that is the right answer, not an obstacle: the merchant has already registered and authorized you, and cancelling the invitation would not undo either. To end an existing relationship the merchant revokes the authorization from their portal; revocation is theirs to make and is final, so a new invitation cannot restore it.…

Invite a merchant to join payware through this ISV. **This is the start of the ISV onboarding flow.** **Endpoint:** POST /isv/invitations -> 201 Created ⚠️ **payware sends no email. You must deliver the link.** The response carries an `invitationLink`, and distributing it - email, SMS, in-app, a printed QR, whatever your channel is - is the ISV's responsibility. Creating the invitation and stopping there means the merchant never hears about it. **The type is auto-detected from the email**, and you do not choose it: - **REGISTRATION** - the email is new to payware. The merchant registers and…

Get full details of one invitation, including its link and the merchant data it pre-fills. **Endpoint:** GET /isv/invitations/{invitationId} **This is how you recover an invitation link** you no longer have - the link is not derivable from the id, so re-reading the invitation is the only way to get it back short of creating a new one. **404** means no invitation with that id belongs to this ISV. Invitations are scoped to their creator, so another ISV's id reads as not-found rather than as forbidden.

Description is built at runtime.

Get download URL for logs archive. Premium plan required. Returns URL for downloading logs as gzipped JSON file.

Query application logs with filters. Premium plan required. Returns paginated JSON log entries for debugging and monitoring your integration.

Get log availability and storage information. Premium plan required. Shows if logs are available, total size, and file count.

Cancel an active transaction as an ISV on behalf of a merchant. **Endpoint:** PATCH /transactions/{transactionId} with `{"status":"CANCELLED","statusMessage":"..."}` Requires ISV authentication with merchant partner ID and OAuth2 token. Only ACTIVE transactions can be cancelled - one already processed answers 409 ERR_ALREADY_PROCESSED. **`statusMessage` is mandatory.** The server rejects a cancellation without one (ERR_MISSING_STATUS_MESSAGE); it is the reason shown to the merchant and recorded against the transaction. Max 100 characters. **You can cancel only what you initiated.** An ISV'…

Create a new transaction through payware as an ISV on behalf of a merchant. ISV partners can create transactions for merchants they have authorization for via OAuth2. Requires valid OAuth2 token obtained from the merchant. **Authentication**: Uses ISV JWT with merchant partner ID in 'aud' claim and OAuth2 token in 'sub' claim. ⚠️ **The MERCHANT's plan governs, not the ISV's.** An on-behalf call inherits the plan of the merchant it acts for, so this endpoint answers **403** (`ERR_METHOD_NOT_ALLOWED_FOR_CURRENT_USER_PLAN`) when that merchant is on **Basic**. Acting on behalf is no longer suff…

Finalize a transaction as a payment institution. This updates the transaction status after execution in your payment network. **Payment Institution Finalization:** - **CONFIRMED**: Transaction executed successfully (requires amount, fee, currency) - **CANCELLED**: Transaction cancelled by creator - **DECLINED**: Transaction declined by payment institution (requires statusMessage) - **FAILED**: Transaction failed during execution (requires statusMessage) **Requirements:** - Only payment institutions can finalize transactions - Currency must match the processing currency of the transaction - A…

Get one completed or expired transaction as an ISV on behalf of a merchant. **Endpoint:** GET /transactions-history/{transactionId} Returns a transaction in a final state: CONFIRMED, DECLINED, FAILED, EXPIRED or CANCELLED. For a transaction still ACTIVE, use `payware_operations_get_transaction_status` instead - the two endpoints cover disjoint sets of transactions and neither falls back to the other. ⚠️ **There is no way to list or search transaction history.** This endpoint takes an id and returns that one transaction. There is no pagination, no date range and no status filter anywhere in …

Get status of an ACTIVE transaction by ID as an ISV on behalf of a merchant. **ISV Authentication:** Uses ISV JWT with merchant partner ID in 'aud' claim and OAuth2 token in 'sub' claim. **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. **Required:** Merchant Partner ID and OAuth2 token for ISV authentication. 🛍️ **Product-o…

Process a PEER transaction as an ISV on behalf of a merchant - the merchant scanning a customer's QR or barcode to collect payment. **Endpoint:** POST /transactions/{transactionId} The customer presents a transaction they created; the merchant (through you) processes it with the amount to collect. Only ACTIVE transactions can be processed - one already processed answers **409 `ERR_ALREADY_PROCESSED`**, which means "already done", not "bad request". ⚠️ **This does not confirm or decline a payment.** Processing hands the transaction to the payer's financial institution, which decides. An ISV …

Simulate the callback payload payware sends to a merchant's callbackUrl, for building and testing a webhook handler as an ISV. **Local only - this makes no API call.** payware has no endpoint that triggers a callback on demand, so nothing here reaches the network. What you get back is the exact payload shape a real TRANSACTION_FINALIZED callback carries, which is what a handler needs in order to be written. **Where the callback goes.** A transaction you create on a merchant's behalf calls back to the `callbackUrl` you give when creating it; a POI sale calls back to the POI's `callbackUrl`. B…

Get transaction information using a Soundbite SDK output file. This allows payment institutions to process transactions using audio-based identifiers. **Soundbite Integration:** - Upload Soundbite SDK output file (.lo extension) - File contains audio-encoded transaction identifier - Alternative to QR/barcode scanning for accessibility - Returns same transaction information as regular transaction lookup **File Requirements:** - File must be output from Soundbite SDK - Supported file format: .lo (Soundbite format) - File must contain valid transaction identifier - Maximum file size limits appl…

Cancel a pending price on a POI, resetting it to IDLE state. **ISV Authentication:** Uses ISV JWT with merchant partner ID and OAuth2 token. **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…

Description is built at runtime.

Description is built at runtime.

Get details of a specific POI (Point of Interaction). **ISV Authentication:** Uses ISV JWT with merchant partner ID and OAuth2 token. **Endpoint:** GET /poi/{poiId} **Use Case:** Retrieve full details of a physical payment point including configuration and current state. **Required:** POI ID, Merchant Partner ID, and OAuth2 token.

Generate a QR code image for a POI that customers can scan. **Endpoint:** GET /poi/{poiId}/image **Authentication:** On behalf of the merchant that owns the POI **Use Case:** Generate QR codes for printing or displaying on screens. **Formats:** PNG (default), SVG, JPG Returns base64-encoded image data that can be saved or displayed. **Required:** POI ID, and the merchant partner ID and OAuth2 token to act on its behalf.

Get the current status of a POI and the outcome of its sales. **ISV Authentication:** Uses ISV JWT with merchant partner ID and OAuth2 token. **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 …

List all POIs (Points of Interaction) for a merchant. **ISV Authentication:** Uses ISV JWT with merchant partner ID and OAuth2 token. **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. **Required:** Merchant Partner ID and OAuth2 token for ISV authentication.

Set a pending price on a POI for customer payment. **ISV Authentication:** Uses ISV JWT with merchant partner ID and OAuth2 token. **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…

Create a new product for inventory management and payment processing on behalf of a merchant (ISV operation). **ISV Authentication**: Requires ISV credentials and OAuth2 token from target merchant. **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:** merchantPartnerId, oauth2Token, name

Create a price schedule for a merchant's product (ISV operation)

Delete an audio file from a merchant's product (ISV operation). This action cannot be undone.

Delete a product from a merchant account (ISV operation). This action cannot be undone.

Delete a price schedule (ISV operation). This action cannot be undone.

Get detailed information about a specific audio file (ISV operation)

Get all registered audio files for a merchant's product (ISV operation)

Get detailed information about a specific product by ID (ISV operation)

Generate a QR code or barcode image for a merchant's product (ISV operation).

Get detailed information about a specific price schedule (ISV operation)

Get all price schedules for a merchant's product (ISV operation)

Get a list of all products for a merchant account (ISV operation)

Register an audio file (soundbite) for a merchant's product (ISV operation). **Supported formats:** MP3, WAV, OGG, M4A, FLAC, AAC, WMA, MP4, MOV, up to 100 MB, holding 2 to 120 seconds of audio **Note:** For video files, only the audio channel is registered

Update audio information (title) or reassign audio to another product (ISV operation)

Update an existing product on behalf of a merchant (ISV operation). Only provide the fields you want to change.

Update an existing price schedule (ISV operation)

Description is built at runtime.

Description is built at runtime.

Format JSON payload with deterministic key sorting for consistent SHA-256 calculation and payware API compliance

Format and validate payware API requests with proper structure and headers

Get MCP server version, status, and environment information