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