Javascript is required.
Please enable it in your browser and reload this page.
Home
Docs
Basic Features
Space Concept
Permission Concept
Manual Tasks
Payment
Overview
Integration Modes
Processors
Subscription
Quick Start
Subscriptions
Products
Coupons
Subscribers
Customize
Document Handling
Resources
Twig Templates
Email Handling
Connect
Connected Services
Printing
Shopify
Wix
Ecwid
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Analytics
Documentation
Documentation
Contact and support
English (United States)
Français (Suisse)
Italiano (Svizzera)
Deutsch (Schweiz)
Web Service API Client
API Version :
V1 (deprecated)
V2.0 (latest)
V1 (deprecated)
This API version (V1) is deprecated.
Please consider upgrading to
API V2.0
which is the latest version.
Select a webservice operation...
Update
Count
Delete
Read
Search
Create
Count
Read
Delete
Search
Count
Search
Read
Search
Read
Count
Process With 3-D Secure
Process
Read
Count
Search
Count
Read
Search
Read
Count
Search
Search
Read
Send Payment Link
Count
Count
updateRecipient
Search
Read
applyFlow
Fetch Charge Flow Payment Page URL
Cancel Charge Flow
Read
All
All
Find by Country
All
Read
Count
Search
All
Search
Update
Create
Count
Delete
selectDefaultAddress
Read
Count
Update
Create
Delete
pinComment
Search
Read
unpinComment
Read
Count
Search
Update
Create
Delete
markAsNotSuitable
Search
Read
markAsSuitable
Count
Read
Count
Search
Read
All
Search
Count
Read
Suspend Dunning Case
Count
Search
Create Dunning Case
Read
Count
Read
Search
Read
Count
Search
Search
Count
Read
Search
Delete
Count
Read
Export
Search
Read
Count
Count
Unlink Invoice
Read
Link Invoice
Search
Search for matchable invoices by query
Count
Read
Discard
Resolve
Search
Search
Update payment connector configuration
Read
Count
Update IBAN
Read
All
All
Read
All
All
Find by Country
Read
Search
Count
Read
Search
Count
Read
All
Read
Count
Search
Create
Read
Update
Delete
All
Read
Search
Read
Count
All
Read
Read
Search
Count
All
Read
Count
Search
Read
Link Device With Terminal
Unlink Device With Terminal
Remotely Trigger Final Balance By Identifier
Remotely Trigger Final Balance
Perform Payment Terminal Transaction (using TID)
Perform Payment Terminal Transaction
Search
Count
Read
Fetch Receipt
All
Read
Count
Search
Read
Delete
Pin
Unpin
Create
Update
Read
Find by refund
Count
Search
Read
succeed
fail
getRefundDocument
Read
getRefundDocumentWithTargetMediaType
Count
Search
create
Read
Count
Search
Update
Count
Read
Search
Update
Search
Create
Update
Count
Read
Read
Terminate
Update Addresses
Search
Update
Create
Count
Suspend
Search
Count
Read
Reactivate
Count
Search
Read
Count
Read
Search
Search
Update
Create
Count
Delete
Read
Read
All
Delete
Count
Read
Search
Update
Create
Search
Update
Create
Delete
Count
Read
Create
Count
Read
discard
Search
Search
Read
Create
Count
Search
Read
Update
Create
Count
Delete
Create
Read
Count
Search
Count
Search
Read
Delete
Search
Update
Create
Read
Count
Search
Create
Update
Count
Delete
Read
Update
Create
Delete
Read
Count
Search
Update
Create
Delete
Read
Search
Count
Search
Update
Create
Delete
Count
Read
Count
Search
Read
Create
Update
Search
Count
Create
Read
Update
Create
Delete
Count
Search
Read
Create
Read
activate
Count
Search
Update
Search
Create
Read
Count
Search
Read
update
Count
Create
Search Subscription Invoices
initialize
initializeSubscriberPresent
update product version
terminate
apply changes
Search
Count
Create
terminate
Read
Read
Search
Count
Create Transaction for Token Update
Count
Create Token Based On Transaction And Fill It With Stored Payment Information
Check If Token Creation Is Possible
Search
Create
Process Transaction
Update
Read
Create Token
Delete
Active Version
Search
Read
Count
Find by transaction
Update
Create
Delete
Unpin
Read
Pin
Count
Search
completePartiallyOffline
completeOnline
completePartiallyOnline
Read
completeOffline
Build JavaScript URL
Read
Unpin
Pin
Update
Create
Delete
Find by invoice
Read
Mark as Paid
getInvoiceDocumentWithTargetMediaType
Search
getInvoiceDocument
Count
replace
Mark as Derecognized
isReplacementPossible
Build JavaScript URL
create
Count
Read
Search
Build Mobile SDK URL
Build Payment Page URL
Export
Confirm
Process One-Click Token with Credentials
getPackingSlip
Fetch Possible Payment Methods
Read
Fetch One Click Tokens with Credentials
Search
Delete One-Click Token with Credentials
getInvoiceDocument
Update
Create
getLatestSuccessfulTransactionLineItemVersion
Create Transaction Credentials
Process Without User Interaction
Fetch Possible Payment Methods with Credentials
Count
Read With Credentials
Create Till Connection Credentials
Fetch Receipts
voidOffline
Count
Search
Read
voidOnline
List Roles
List Roles
Read
Search
Update
Create
Delete
Count
Read
Search
Count
Update
Create
Read
Delete
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
POST
/api/subscription-metric/create
Send
Form
Raw
Query Parameters
Body Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
Body Parameters
entity
required
Add
Remove