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