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...
Create
Search
Count
Read
Delete
Update
Search
Read
Count
Delete
Read
Count
Search
Read
Count
Search
Process
Process With 3-D Secure
Read
Count
Search
Search
Read
Count
Read
Count
Search
Send Payment Link
Count
Search
Read
Search
Fetch Charge Flow Payment Page URL
Read
applyFlow
Cancel Charge Flow
updateRecipient
Count
All
Read
All
All
Find by Country
Search
Read
Count
All
selectDefaultAddress
Read
Count
Search
Update
Create
Delete
Read
Search
Delete
pinComment
Count
unpinComment
Update
Create
Create
Delete
Count
Read
Search
Update
Mark Case As Prepared
Create
Add Collected Amount
Attach Document
Delete
Close
Count
Mark Case As Reviewed
Update
Documents
Search
Read
Search
Count
Read
Read
All
Search
Count
markAsNotSuitable
markAsSuitable
Read
Count
Search
Read
Read
All
Search
Read
Count
Create Dunning Case
Count
Read
Search
Suspend Dunning Case
Read
Count
Search
Search
Count
Read
Search
Read
Count
Delete
Read
Export
Count
Search
Read
Count
Create Installment Payment
Search
Search
Read
Count
Calculate Plans
Read
Search
Count
Search
Count
Read
Count
Search
Read
Unlink Invoice
Read
Count
Link Invoice
Search
Discard
Search
Search for matchable invoices by query
Resolve
Count
Read
Update payment connector configuration
Count
Search
Read
Update IBAN
Read
All
Read
All
All
All
Read
Find by Country
Read
Count
Search
Calculate
Insert or Update Connector
Activate Processor for Production
Delete Processor
Insert or Update Processor
Update Void
Delete Connector
Update Refund
Update Completion
Update Charge Attempt
Read
Count
Search
Read
All
Count
Update
Search
Read
Create
Delete
Read
All
Count
Search
Read
All
Read
Count
Read
Search
Read
All
Read
Count
Search
Link Device With Terminal
Remotely Trigger Final Balance
Remotely Trigger Final Balance By Identifier
Unlink Device With Terminal
Trigger Payment Terminal Configuration (using TID)
Perform Payment Terminal Transaction (using TID)
Trigger Payment Terminal Configuration
Perform Payment Terminal Transaction
Read
Count
Fetch Receipt
Search
All
Read
Count
Search
Read
Create
Pin
Unpin
Delete
Read
Find by refund
Update
Count
Search
Read
Count
create
fail
getRefundDocumentWithTargetMediaType
Search
getRefundDocument
succeed
Read
Read
Search
Count
Update
Read
Count
Search
Update
Update
Create
Count
Search
Read
Read
Search
Count
Terminate
Update
Create
Update Addresses
Reactivate
Count
Suspend
Read
Search
Search
Read
Count
Read
Search
Count
Delete
Read
Search
Update
Create
Count
All
Read
Count
Delete
Search
Update
Read
Create
Read
Delete
Count
Update
Create
Search
Read
Count
discard
Search
Create
Search
Create
Read
Count
Count
Update
Create
Search
Delete
Read
Create
Search
Count
Read
Search
Read
Count
Update
Create
Read
Count
Delete
Search
Create
Delete
Read
Update
Search
Count
Search
Update
Create
Read
Count
Delete
Read
Count
Search
Update
Create
Delete
Read
Search
Update
Count
Create
Delete
Update
Search
Create
Count
Read
Search
Count
Create
Read
Create
Delete
Read
Count
Search
Update
Create
activate
Search
Count
Read
Update
Count
Search
Read
Create
initializeSubscriberPresent
Count
Search
terminate
update
Create
initialize
apply changes
update product version
Read
Search Subscription Invoices
terminate
Count
Search
Create
Read
Search
Count
Read
Create
Count
Delete
Process Transaction
Read
Check If Token Creation Is Possible
Create Token Based On Transaction And Fill It With Stored Payment Information
Update
Create Token
Search
Create Transaction for Token Update
Read
Count
Search
Active Version
Find by transaction
Unpin
Update
Create
Pin
Delete
Read
completeOffline
Count
completePartiallyOnline
completeOnline
Search
Read
completePartiallyOffline
Build JavaScript URL
Pin
Delete
Find by invoice
Update
Unpin
Read
Create
Read
replace
getInvoiceDocumentWithTargetMediaType
Search
isReplacementPossible
Mark as Paid
Count
Mark as Derecognized
getInvoiceDocument
Build JavaScript URL
Read
Search
create
Count
Build Mobile SDK URL
Build Payment Page URL
Export
Fetch One Click Tokens with Credentials
getLatestSuccessfulTransactionLineItemVersion
Get Successful Charge Attempt
Read With Credentials
Search
getInvoiceDocument
getPackingSlip
Delete One-Click Token with Credentials
Update
Create
Fetch Possible Payment Methods with Credentials
Confirm
Process Without User Interaction
Create Transaction Credentials
Count
Read
Process One-Click Token with Credentials
Fetch Possible Payment Methods
Create Till Connection Credentials
Fetch Receipts
Read
voidOffline
Search
Count
voidOnline
List Roles
List Roles
Read
Create
Count
Read
Delete
Search
Update
Create
Delete
Read
Count
Search
Update
Request
Documentation
Careful!
This is a live request, sending it can result in actual changes.
GET
/api/transaction-iframe/javascript-url
Send
Form
Raw
Query Parameters
Press
Ctrl
+
Enter
to send the request.
Form
Raw
Query Parameters
spaceId
Integer
required
id
Integer
required
Preprod
2.217.0
Remove Cookie