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