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