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