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