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
Delete
Search
Read
Count
Create
Read
Delete
Count
Search
Read
Search
Count
Search
Read
Count
Process With 3-D Secure
Process
Count
Search
Read
Read
Search
Count
Count
Search
Read
Send Payment Link
Search
Count
Read
updateRecipient
applyFlow
Search
Read
Fetch Charge Flow Payment Page URL
Count
Cancel Charge Flow
Read
All
All
Find by Country
All
Count
Read
Search
All
selectDefaultAddress
Delete
Create
Search
Count
Read
Update
Count
pinComment
Delete
Create
unpinComment
Update
Search
Read
Read
Delete
Create
Search
Update
Count
Read
markAsSuitable
Search
markAsNotSuitable
Count
Search
Read
Count
Read
All
Count
Search
Read
Read
Create Dunning Case
Suspend Dunning Case
Count
Search
Read
Search
Count
Count
Read
Search
Read
Count
Search
Count
Read
Delete
Search
Export
Read
Count
Search
Search
Read
Unlink Invoice
Link Invoice
Count
Resolve
Search for matchable invoices by query
Search
Discard
Read
Count
Read
Search
Update IBAN
Count
Update payment connector configuration
All
Read
Read
All
All
All
Read
Find by Country
Search
Read
Count
Search
Read
Count
All
Read
Read
Count
Update
Delete
Create
Search
All
Read
Count
Search
Read
All
Read
Read
Search
Count
Read
All
Unlink Device With Terminal
Read
Remotely Trigger Final Balance
Search
Count
Remotely Trigger Final Balance By Identifier
Link Device With Terminal
Perform Payment Terminal Transaction
Perform Payment Terminal Transaction (using TID)
Trigger Payment Terminal Configuration (using TID)
Trigger Payment Terminal Configuration
Search
Count
Read
Fetch Receipt
Read
All
Read
Count
Search
Update
Unpin
Delete
Create
Read
Pin
Find by refund
Count
Read
Search
create
Read
Count
succeed
Search
fail
getRefundDocumentWithTargetMediaType
getRefundDocument
Read
Search
Count
Update
Search
Update
Read
Count
Update
Read
Create
Search
Count
Terminate
Count
Create
Search
Update Addresses
Read
Update
Suspend
Reactivate
Search
Read
Count
Read
Search
Count
Search
Count
Read
Read
Count
Delete
Create
Search
Update
Read
All
Count
Delete
Create
Search
Update
Read
Search
Read
Create
Update
Count
Delete
discard
Read
Create
Search
Count
Create
Count
Search
Read
Count
Delete
Create
Update
Search
Read
Search
Read
Create
Count
Search
Count
Read
Read
Delete
Create
Search
Count
Update
Read
Count
Update
Delete
Create
Search
Delete
Create
Search
Read
Update
Count
Delete
Create
Count
Update
Read
Search
Read
Count
Delete
Create
Search
Update
Read
Count
Update
Create
Search
Read
Create
Search
Count
Delete
Create
Count
Read
Search
Update
Update
Count
Read
Create
activate
Search
Create
Search
Read
Count
Create
Count
Search
initializeSubscriberPresent
Read
terminate
Search Subscription Invoices
update
initialize
update product version
apply changes
terminate
Count
Read
Create
Search
Read
Count
Search
Create Token
Search
Count
Create Transaction for Token Update
Create Token Based On Transaction And Fill It With Stored Payment Information
Process Transaction
Read
Check If Token Creation Is Possible
Update
Delete
Create
Active Version
Count
Read
Search
Unpin
Find by transaction
Delete
Create
Pin
Read
Update
Count
Read
completePartiallyOnline
completeOffline
Search
completeOnline
completePartiallyOffline
Build JavaScript URL
Read
Find by invoice
Create
Unpin
Update
Delete
Pin
getInvoiceDocumentWithTargetMediaType
Count
getInvoiceDocument
Mark as Paid
Read
Search
replace
Mark as Derecognized
isReplacementPossible
Build JavaScript URL
Read
Count
create
Search
Build Mobile SDK URL
Build Payment Page URL
Fetch Possible Payment Methods with Credentials
Read
Export
Read With Credentials
Update
Fetch One Click Tokens with Credentials
Process One-Click Token with Credentials
getLatestSuccessfulTransactionLineItemVersion
Delete One-Click Token with Credentials
Get Successful Charge Attempt
getPackingSlip
Process Without User Interaction
Confirm
Fetch Possible Payment Methods
Count
Create
getInvoiceDocument
Create Transaction Credentials
Search
Fetch Receipts
Create Till Connection Credentials
Read
Count
voidOffline
voidOnline
Search
List Roles
List Roles
Read
Delete
Create
Search
Count
Update
Read
Read
Delete
Create
Update
Count
Search
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