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