Javascript is required.
Please enable it in your browser and reload this page.
Docs
Basic Features
Space Concept
Permission Concept
Manual Tasks
Payment
Overview
Integration Modes
Processors
Debt Collection
Debt Collection
Debt Collectors
Subscription
Quick Start
Subscriptions
Products
Coupons
Subscribers
Customize
Document Handling
Resources
Twig Templates
Email Handling
Connect
Connected Services
Printing
Slack
Lightspeed eCom
Shopify
Ecwid
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Analytics
Documentation
Documentation
English (United States)
Français (France)
Deutsch (Deutschland)
Italiano (Italia)
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
Read
Search
Update
Delete
Create
Search
Read
Delete
Count
Search
Read
Count
Count
Read
Search
Process
Process With 3-D Secure
Search
Count
Read
Search
Read
Count
Count
Read
Search
Search
Read
Count
Send Payment Link
Search
updateRecipient
Fetch Charge Flow Payment Page URL
Read
Cancel Charge Flow
Count
applyFlow
All
Read
All
Find by Country
All
Search
Count
Read
All
Delete
Create
Update
selectDefaultAddress
Read
Search
Count
Create
Search
Read
Count
unpinComment
Update
Delete
pinComment
Delete
Create
Read
Update
Search
Count
Mark Case As Prepared
Mark Case As Reviewed
Close
Attach Document
Search
Count
Update
Delete
Create
Documents
Read
Add Collected Amount
Read
Count
Search
Read
All
Count
Search
Read
markAsSuitable
markAsNotSuitable
Search
Count
Read
All
Read
Search
Count
Read
Suspend Dunning Case
Search
Count
Read
Create Dunning Case
Read
Search
Count
Count
Search
Read
Read
Count
Search
Export
Read
Search
Delete
Count
Create Installment Payment
Search
Read
Count
Search
Count
Read
Calculate Plans
Read
Count
Search
Search
Count
Read
Count
Search
Read
Count
Read
Search
Unlink Invoice
Link Invoice
Search for matchable invoices by query
Search
Read
Resolve
Discard
Count
Search
Count
Read
Update payment connector configuration
Update IBAN
Read
All
Read
All
All
Read
Find by Country
All
Count
Read
Search
Calculate
Update Void
Update Refund
Update Completion
Delete Connector
Delete Processor
Insert or Update Connector
Insert or Update Processor
Activate Processor for Production
Update Charge Attempt
Count
Read
Search
Read
All
Delete
Create
Update
Count
Search
Read
All
Read
Read
Count
Search
Read
All
Read
Count
Search
All
Read
Link Device With Terminal
Remotely Trigger Final Balance
Search
Remotely Trigger Final Balance By Identifier
Read
Count
Unlink Device With Terminal
Trigger Payment Terminal Configuration (using TID)
Perform Payment Terminal Transaction
Perform Payment Terminal Transaction (using TID)
Trigger Payment Terminal Configuration
Count
Read
Fetch Receipt
Search
Read
All
Search
Read
Count
Pin
Find by refund
Update
Delete
Create
Unpin
Read
Count
Read
Search
succeed
Count
create
Search
getRefundDocumentWithTargetMediaType
Read
fail
getRefundDocument
Update
Read
Count
Search
Read
Search
Count
Update
Search
Update
Create
Read
Count
Terminate
Count
Search
Update Addresses
Create
Read
Update
Reactivate
Count
Suspend
Read
Search
Search
Read
Count
Count
Read
Search
Search
Count
Delete
Create
Update
Read
Read
All
Create
Search
Count
Read
Update
Delete
Search
Update
Delete
Create
Read
Count
Count
Create
discard
Search
Read
Create
Read
Search
Count
Count
Search
Update
Delete
Create
Read
Search
Create
Count
Read
Count
Read
Search
Count
Read
Search
Delete
Create
Update
Read
Search
Delete
Create
Count
Update
Read
Search
Delete
Create
Count
Update
Create
Read
Count
Search
Update
Delete
Search
Read
Delete
Create
Count
Update
Read
Search
Count
Update
Create
Count
Search
Read
Create
Search
Count
Delete
Create
Update
Read
activate
Update
Search
Count
Create
Read
Count
Search
Create
Read
Search Subscription Invoices
Search
apply changes
update product version
initialize
Create
update
terminate
Count
Read
initializeSubscriberPresent
Read
terminate
Search
Count
Create
Count
Search
Read
Create Token
Create Transaction for Token Update
Count
Check If Token Creation Is Possible
Search
Read
Delete
Create
Process Transaction
Create Token Based On Transaction And Fill It With Stored Payment Information
Update
Active Version
Count
Read
Search
Pin
Find by transaction
Read
Unpin
Update
Delete
Create
completeOnline
completeOffline
completePartiallyOnline
Read
Search
Count
completePartiallyOffline
Build JavaScript URL
Pin
Update
Delete
Create
Find by invoice
Unpin
Read
Count
replace
Mark as Paid
getInvoiceDocument
Mark as Derecognized
getInvoiceDocumentWithTargetMediaType
isReplacementPossible
Search
Read
Build JavaScript URL
Search
create
Read
Count
Build Mobile SDK URL
Build Payment Page URL
Read
Process Without User Interaction
Export
Read With Credentials
getPackingSlip
Count
Search
Confirm
getLatestSuccessfulTransactionLineItemVersion
Fetch Possible Payment Methods with Credentials
Create
Process One-Click Token with Credentials
getInvoiceDocument
Create Transaction Credentials
Update
Fetch One Click Tokens with Credentials
Fetch Possible Payment Methods
Delete One-Click Token with Credentials
Fetch Receipts
Create Till Connection Credentials
Count
Search
Read
voidOffline
voidOnline
List Roles
List Roles
Read
Update
Delete
Read
Count
Create
Search
Count
Read
Create
Search
Update
Delete
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
GET
/api/customer/read
Send
Form
Raw
Query Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
id
Integer
required