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