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