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