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