Javascript is required.
Please enable it in your browser and reload this page.
Home
Docs
Basic Features
Space Concept
Permission Concept
Manual Tasks
Payment
Overview
Integration Modes
Processors
Subscription
Quick Start
Subscriptions
Products
Coupons
Subscribers
Customize
Document Handling
Resources
Twig Templates
Email Handling
Connect
Connected Services
Printing
Shopify
Wix
Ecwid
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Analytics
Documentation
Documentation
Contact and support
English (United States)
Français (Suisse)
Italiano (Svizzera)
Deutsch (Schweiz)
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
Count
Search
Create
Read
Delete
Count
Search
Read
Delete
Search
Read
Count
Search
Count
Read
Process With 3-D Secure
Process
Count
Read
Search
Search
Count
Read
Count
Read
Search
Read
Send Payment Link
Search
Count
Search
Fetch Charge Flow Payment Page URL
applyFlow
Count
Read
updateRecipient
Cancel Charge Flow
All
Read
All
Find by Country
All
Search
Count
Read
All
Update
Count
selectDefaultAddress
Read
Search
Create
Delete
Update
unpinComment
Read
Count
Create
Search
Delete
pinComment
Read
Search
Create
Delete
Count
Update
Count
Read
markAsNotSuitable
markAsSuitable
Search
Count
Search
Read
Read
All
Search
Count
Read
Count
Suspend Dunning Case
Read
Search
Create Dunning Case
Count
Read
Search
Search
Count
Read
Count
Read
Search
Search
Export
Delete
Read
Count
Read
Search
Count
Search
Link Invoice
Read
Count
Unlink Invoice
Search for matchable invoices by query
Read
Discard
Resolve
Search
Count
Update IBAN
Search
Count
Read
Update payment connector configuration
All
Read
Read
All
All
Read
Find by Country
All
Count
Read
Search
Count
Search
Read
Read
All
Count
Search
Read
Create
Delete
Update
Read
All
Search
Count
Read
All
Read
Count
Read
Search
All
Read
Remotely Trigger Final Balance
Remotely Trigger Final Balance By Identifier
Link Device With Terminal
Read
Count
Search
Unlink Device With Terminal
Trigger Payment Terminal Configuration
Perform Payment Terminal Transaction
Perform Payment Terminal Transaction (using TID)
Trigger Payment Terminal Configuration (using TID)
Revert terminal transaction
Search
Fetch Receipt
Count
Read
All
Read
Read
Search
Count
Create
Delete
Update
Read
Unpin
Find by refund
Pin
Count
Read
Search
getRefundDocumentWithTargetMediaType
create
fail
getRefundDocument
succeed
Count
Read
Search
Update
Count
Search
Read
Count
Search
Read
Update
Search
Create
Update
Read
Count
Update
Count
Terminate
Update Addresses
Search
Read
Create
Count
Search
Read
Suspend
Reactivate
Count
Read
Search
Count
Read
Search
Create
Delete
Read
Update
Search
Count
All
Read
Delete
Update
Count
Read
Create
Search
Search
Create
Delete
Read
Update
Count
Search
Create
Count
Read
discard
Search
Create
Read
Count
Search
Create
Count
Delete
Read
Update
Count
Read
Search
Create
Count
Read
Search
Search
Create
Count
Delete
Read
Update
Search
Create
Delete
Count
Read
Update
Create
Delete
Read
Update
Count
Search
Create
Search
Read
Delete
Update
Count
Search
Create
Read
Delete
Update
Count
Search
Create
Update
Read
Count
Search
Create
Count
Read
Search
Create
Read
Delete
Count
Update
Search
activate
Create
Read
Update
Count
Count
Create
Read
Search
Search
Create
Search Subscription Invoices
apply changes
Read
initializeSubscriberPresent
update
update product version
Count
initialize
terminate
Read
Search
Create
Count
terminate
Search
Count
Read
Create Token
Check If Token Creation Is Possible
Update
Create Token Based On Transaction And Fill It With Stored Payment Information
Read
Count
Process Transaction
Create Transaction for Token Update
Search
Create
Delete
Search
Read
Active Version
Count
Find by transaction
Pin
Create
Read
Delete
Unpin
Update
completeOffline
Search
completePartiallyOffline
completePartiallyOnline
Read
Count
completeOnline
Build JavaScript URL
Create
Unpin
Read
Delete
Pin
Find by invoice
Update
getInvoiceDocumentWithTargetMediaType
getInvoiceDocument
Mark as Paid
Search
Mark as Derecognized
replace
Read
Count
isReplacementPossible
Build JavaScript URL
Read
Search
Count
create
Build Mobile SDK URL
Build Payment Page URL
Export
Create
getInvoiceDocument
Process Without User Interaction
Process One-Click Token with Credentials
Read
Update
Read With Credentials
Confirm
Create Transaction Credentials
Fetch Possible Payment Methods
Fetch One Click Tokens with Credentials
Delete One-Click Token with Credentials
Fetch Possible Payment Methods with Credentials
Get Successful Charge Attempt
Count
getLatestSuccessfulTransactionLineItemVersion
getPackingSlip
Search
Create Till Connection Credentials
Fetch Receipts
voidOffline
Count
voidOnline
Search
Read
List Roles
List Roles
Read
Read
Delete
Count
Update
Create
Search
Delete
Update
Count
Read
Create
Search
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
GET
/api/space/read
Send
Form
Raw
Query Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
id
Integer
required