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