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