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