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