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