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