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