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