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
Search
Read
Update
Count
Delete
Search
Count
Read
Delete
Read
Count
Search
Count
Read
Search
Process With 3-D Secure
Process
Read
Search
Count
Search
Read
Count
Search
Read
Count
Read
Send Payment Link
Count
Search
Read
updateRecipient
Cancel Charge Flow
applyFlow
Search
Fetch Charge Flow Payment Page URL
Count
Read
All
All
All
Find by Country
Search
Read
Count
All
Update
selectDefaultAddress
Create
Read
Count
Search
Delete
Read
Count
unpinComment
Update
Delete
pinComment
Create
Search
Create
Read
Search
Count
Delete
Update
Create
Add Collected Amount
Mark Case As Prepared
Search
Read
Documents
Mark Case As Reviewed
Update
Delete
Attach Document
Count
Close
Search
Count
Read
All
Read
markAsNotSuitable
Search
markAsSuitable
Count
Read
Read
Search
Count
All
Read
Read
Count
Search
Create Dunning Case
Suspend Dunning Case
Count
Search
Read
Search
Read
Count
Count
Search
Read
Search
Read
Count
Delete
Read
Count
Search
Export
Count
Read
Create Installment Payment
Search
Count
Search
Read
Calculate Plans
Read
Search
Count
Search
Read
Count
Read
Count
Search
Read
Unlink Invoice
Search
Count
Link Invoice
Search
Read
Resolve
Discard
Search for matchable invoices by query
Count
Read
Update payment connector configuration
Search
Update IBAN
Count
Read
All
All
Read
All
Read
Find by Country
All
Read
Count
Search
Calculate
Insert or Update Connector
Delete Processor
Update Refund
Update Completion
Delete Connector
Update Void
Activate Processor for Production
Insert or Update Processor
Update Charge Attempt
Count
Search
Read
All
Read
Count
Update
Delete
Create
Read
Search
Read
All
Count
Search
Read
All
Read
Count
Search
Read
Read
All
Link Device With Terminal
Unlink Device With Terminal
Count
Search
Remotely Trigger Final Balance
Read
Remotely Trigger Final Balance By Identifier
Trigger Payment Terminal Configuration
Perform Payment Terminal Transaction
Perform Payment Terminal Transaction (using TID)
Trigger Payment Terminal Configuration (using TID)
Revert terminal transaction
Search
Count
Fetch Receipt
Read
Read
All
Search
Count
Read
Find by refund
Unpin
Pin
Update
Delete
Create
Read
Read
Search
Count
Read
getRefundDocumentWithTargetMediaType
fail
create
Search
Count
getRefundDocument
succeed
Read
Search
Count
Update
Count
Search
Update
Read
Update
Create
Count
Search
Read
Count
Search
Update Addresses
Update
Terminate
Read
Create
Reactivate
Count
Suspend
Read
Search
Read
Count
Search
Search
Read
Count
Delete
Update
Create
Search
Read
Count
All
Read
Read
Count
Delete
Update
Create
Search
Count
Search
Read
Update
Delete
Create
Create
Read
Search
discard
Count
Create
Search
Count
Read
Count
Search
Read
Update
Delete
Create
Count
Read
Create
Search
Read
Count
Search
Search
Delete
Update
Create
Count
Read
Count
Search
Update
Delete
Read
Create
Search
Count
Delete
Update
Create
Read
Delete
Update
Create
Search
Read
Count
Read
Delete
Update
Create
Search
Count
Read
Update
Create
Count
Search
Create
Count
Search
Read
Delete
Update
Create
Read
Count
Search
Search
Count
activate
Read
Update
Create
Create
Count
Search
Read
Count
initializeSubscriberPresent
update
apply changes
Create
initialize
Search
Read
terminate
update product version
Search Subscription Invoices
Read
Search
terminate
Count
Create
Search
Read
Count
Check If Token Creation Is Possible
Create Transaction for Token Update
Process Transaction
Create Token
Delete
Update
Create
Read
Create Token Based On Transaction And Fill It With Stored Payment Information
Search
Count
Search
Read
Count
Active Version
Create
Unpin
Find by transaction
Update
Read
Delete
Pin
completePartiallyOffline
completePartiallyOnline
completeOffline
Count
Search
completeOnline
Read
Build JavaScript URL
Pin
Read
Unpin
Update
Find by invoice
Delete
Create
Search
Count
getInvoiceDocumentWithTargetMediaType
Mark as Derecognized
Mark as Paid
replace
Read
isReplacementPossible
getInvoiceDocument
Build JavaScript URL
Read
create
Count
Search
Build Mobile SDK URL
Build Payment Page URL
Create Transaction Credentials
getPackingSlip
Export
Delete One-Click Token with Credentials
getLatestSuccessfulTransactionLineItemVersion
Get Successful Charge Attempt
Fetch Possible Payment Methods with Credentials
Process Without User Interaction
Confirm
Read
Update
Count
getInvoiceDocument
Create
Fetch One Click Tokens with Credentials
Read With Credentials
Process One-Click Token with Credentials
Fetch Possible Payment Methods
Search
Create Till Connection Credentials
Fetch Receipts
voidOnline
voidOffline
Count
Read
Search
List Roles
List Roles
Read
Search
Delete
Update
Read
Count
Create
Delete
Update
Create
Read
Search
Count
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
GET
/api/subscription-product-retirement/read
Send
Form
Raw
Query Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
id
Integer
required