Javascript is required.
Please enable it in your browser and reload this page.
Docs
Basic Features
Space Concept
Permission Concept
Manual Tasks
Payment
Overview
Integration Modes
Processors
Debt Collection
Debt Collection
Debt Collectors
Subscription
Quick Start
Subscriptions
Products
Coupons
Subscribers
Customize
Document Handling
Resources
Twig Templates
Email Handling
Connect
Connected Services
Printing
Slack
Lightspeed eCom
Shopify
Ecwid
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Analytics
Documentation
Documentation
English (United States)
Français (France)
Deutsch (Deutschland)
Italiano (Italia)
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...
Create
Read
Search
Delete
Update
Count
Read
Search
Delete
Count
Search
Read
Count
Read
Search
Count
Process
Process With 3-D Secure
Count
Read
Search
Search
Read
Count
Count
Read
Search
Read
Search
Count
Send Payment Link
Cancel Charge Flow
Fetch Charge Flow Payment Page URL
updateRecipient
Count
Search
Read
applyFlow
Read
All
All
Find by Country
All
Count
Read
Search
All
Search
Delete
Count
Read
Update
selectDefaultAddress
Create
Read
Create
Count
Update
Search
pinComment
Delete
unpinComment
Update
Read
Create
Search
Count
Delete
Delete
Attach Document
Add Collected Amount
Read
Count
Mark Case As Prepared
Mark Case As Reviewed
Update
Create
Documents
Close
Search
Search
Read
Count
All
Read
Read
Count
markAsSuitable
Search
markAsNotSuitable
Count
Search
Read
Read
All
Search
Read
Count
Search
Read
Create Dunning Case
Suspend Dunning Case
Count
Search
Count
Read
Search
Count
Read
Read
Count
Search
Search
Delete
Read
Count
Export
Create Installment Payment
Search
Read
Count
Read
Count
Search
Calculate Plans
Read
Count
Search
Count
Read
Search
Search
Count
Read
Search
Count
Unlink Invoice
Link Invoice
Read
Search for matchable invoices by query
Search
Read
Discard
Resolve
Count
Update payment connector configuration
Count
Update IBAN
Search
Read
All
Read
All
Read
All
Read
Find by Country
All
Count
Read
Search
Calculate
Update Refund
Activate Processor for Production
Update Completion
Update Void
Insert or Update Processor
Insert or Update Connector
Delete Processor
Delete Connector
Update Charge Attempt
Search
Count
Read
All
Read
Delete
Read
Update
Create
Search
Count
Read
All
Search
Read
Count
All
Read
Read
Search
Count
Read
All
Unlink Device With Terminal
Remotely Trigger Final Balance By Identifier
Link Device With Terminal
Count
Search
Remotely Trigger Final Balance
Read
Trigger Payment Terminal Configuration (using TID)
Trigger Payment Terminal Configuration
Perform Payment Terminal Transaction
Perform Payment Terminal Transaction (using TID)
Fetch Receipt
Read
Search
Count
Read
All
Search
Count
Read
Pin
Unpin
Update
Create
Read
Find by refund
Delete
Read
Count
Search
getRefundDocumentWithTargetMediaType
Search
succeed
Count
getRefundDocument
create
fail
Read
Read
Count
Update
Search
Read
Count
Update
Search
Update
Read
Create
Count
Search
Terminate
Update Addresses
Update
Create
Search
Count
Read
Search
Reactivate
Read
Suspend
Count
Search
Read
Count
Read
Search
Count
Count
Update
Create
Search
Read
Delete
Read
All
Create
Update
Read
Search
Delete
Count
Update
Search
Delete
Read
Count
Create
Create
Search
Count
discard
Read
Create
Count
Search
Read
Create
Update
Search
Read
Delete
Count
Count
Create
Search
Read
Search
Count
Read
Delete
Count
Read
Update
Create
Search
Update
Create
Count
Search
Read
Delete
Create
Count
Search
Delete
Update
Read
Search
Delete
Read
Create
Count
Update
Delete
Update
Read
Create
Search
Count
Create
Read
Search
Count
Update
Search
Read
Count
Create
Count
Update
Create
Search
Delete
Read
Count
activate
Update
Read
Create
Search
Search
Count
Create
Read
Create
Search
Search Subscription Invoices
apply changes
Count
initialize
Read
terminate
update product version
initializeSubscriberPresent
update
Create
terminate
Read
Search
Count
Read
Count
Search
Create Transaction for Token Update
Process Transaction
Read
Update
Create
Count
Search
Check If Token Creation Is Possible
Create Token
Delete
Create Token Based On Transaction And Fill It With Stored Payment Information
Read
Search
Count
Active Version
Find by transaction
Create
Pin
Update
Read
Unpin
Delete
completePartiallyOffline
completeOffline
completeOnline
completePartiallyOnline
Search
Count
Read
Build JavaScript URL
Unpin
Delete
Find by invoice
Read
Create
Update
Pin
replace
getInvoiceDocumentWithTargetMediaType
isReplacementPossible
getInvoiceDocument
Search
Mark as Derecognized
Count
Read
Mark as Paid
Build JavaScript URL
Count
Read
create
Search
Build Mobile SDK URL
Build Payment Page URL
Delete One-Click Token with Credentials
Read With Credentials
Fetch Possible Payment Methods with Credentials
getInvoiceDocument
Confirm
Fetch Possible Payment Methods
Count
Create Transaction Credentials
Process Without User Interaction
Read
getPackingSlip
Update
Export
Process One-Click Token with Credentials
Create
getLatestSuccessfulTransactionLineItemVersion
Search
Fetch One Click Tokens with Credentials
Fetch Receipts
Create Till Connection Credentials
Count
voidOffline
voidOnline
Search
Read
List Roles
List Roles
Read
Create
Update
Count
Search
Read
Delete
Create
Read
Update
Search
Delete
Count
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
GET
/api/subscription-metric/read
Send
Form
Raw
Query Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
id
Integer
required
Preprod
2.204.3
Remove Cookie