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