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