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
Shopify
Wix
Webhooks
API Reference
Web Service API Client
Web Service API
Data Models
Release Notes
Types
Labels
Web App
Analytics
Documentation
Documentation
English (United States)
Deutsch (Schweiz)
English (United Kingdom)
Deutsch (Deutschland)
Deutsch (Österreich)
Français (France)
Français (Suisse)
Italiano (Italia)
Italiano (Svizzera)
Web Service API Client
API Version :
V2.0 (latest)
V2.0 (latest)
V1 (deprecated)
Select a webservice operation...
List all accounts
Retrieve an account
Search accounts
Create an account
Activate an account
Deactivate an account
Update an account
Delete an account
Get portion of query executions for account
Retrieve a query execution information by its external id
Generate a temporary URL to download the query result. It retrieves the query by its external id
Retrieve a query execution information by its query token
Generate a temporary URL to download the query result. It retrieves the query by its query token
Submit a query execution
Cancel a query execution, identifying it by its external id.
Cancel a query execution, identifying it by its query token.
List all application users
Retrieve an application user
List a user's authentication keys
Search application users
Create an application user
Generate a new authentication key
Update an application user
Delete an application user
Deactivate an authentication key
List all bank accounts
Retrieve a bank account
Search bank accounts
List all bank transactions
Retrieve a bank transaction
Search bank transactions
Create a boarding subscription information for an account
Create new Boarding Trial Subscription to Account
List all charge attempts
Retrieve a charge attempt
Search charge attempts
List all charge bank transactions
Retrieve a charge bank transaction
Search charge bank transactions
List all charge flow levels
Retrieve a charge flow level
Search charge flow levels
Send a payment link
List all charge flows
Retrieve a charge flow
Search charge flows
List all charge flow payment links
Retrieve a charge flow payment link
Search charge flow payment links
List all client platforms
Retrieve the client platform based on id
Search client platforms
List all transaction completions
Retrieve a transaction completion
Search transaction completions
List all condition types.
Retrieve a condition type.
Search condition types.
List consumed resources
List all countries
Retrieve a country
List all states for a country
Search countries
List all country states
Retrieve a country state
List all currencies
Retrieve a currency
Search currencies
List all currency bank accounts
Retrieve a currency bank account
Search currency bank accounts
List all customer addresses
Retrieve a customer address
Search customer addresses
Create a customer address
Set the default address for a customer
Update a customer address
Delete a customer address
List all customer comments
Retrieve a customer comment
Search customer comments
Create a customer comment
Pin a comment to the top
Remove a pinned comment from the top
Update a customer comment
Delete a customer comment
List all customers
Retrieve a customer
List a customer's email addresses
Search customers
Create a customer
Merge two customers
Create multiple customers
Update a customer
Update multiple customers
Delete a customer
Delete multiple customers
List all debt collection cases
Retrieve a debt collection case
Retrieve all documents of a debt collection case
Search debt collection cases
Create a debt collection case
Close a debt collection case
Attach a document to a debt collection case
Mark a debt collection case as prepared
Mark a debt collection case as reviewed
Create a payment receipt for a debt collection case
Update a debt collection case
Delete a debt collection case
List all debt collector configurations
Retrieve a debt collector configuration
Search debt collector configurations
Create a debt collector configuration
Update a debt collector configuration
Delete a debt collector configuration
List all debt collectors
Retrieve a debt collector
Search debt collectors
List all delivery indications
Retrieve a delivery indication
Search delivery indications
Mark a delivery indication as not suitable.
Mark a delivery indication as suitable.
List all document template types
Retrieve a document template type
Search document template types
List all document templates
Retrieve a document template
Search document templates
List all dunning case levels
Retrieve a dunning case level
Search dunning case levels
List all dunning cases
Retrieve a dunning case
Search dunning cases
Suspend a dunning case
Create a dunning case for an invoice
List all dunning flow levels
Retrieve a dunning flow level
Search dunning flow levels
List all dunning flows
Retrieve a dunning flow
Search dunning flows
Get Express Checkout Session details
Create a new Express Checkout Session
Process Express Checkout Session
List all external transfer bank transactions
Retrieve an external transfer bank transaction
Search external transfer bank transactions
Search fulfillments
Create a fulfillment
Confirm in-store pickup
Update tracking number
List all human users
Retrieve a human user
Export human users
Search human users
Create a human user
Update a human user
Delete a human user
List all internal transfer bank transactions
Retrieve an internal transfer bank transaction
Search internal transfer bank transactions
List all transaction invoice comments
Retrieve a transaction invoice comment
Search transaction invoice comments
Create a transaction invoice comment
Pin a comment to the top
Remove the pinned comment from the top
Update a transaction comment
Delete a transaction comment
List all invoice reconciliation record invoice links
Retrieve an invoice reconciliation record invoice link
Search invoice reconciliation record invoice links
Link an invoice
Unlink an invoice
List all invoice reconciliation records
Retrieve an invoice reconciliation record
Search invoice reconciliation records
Discard an invoice reconciliation record
Resolve an invoice reconciliation record
List all invoice reimbursements
Retrieve an invoice reimbursement
Search invoice reimbursements
Update payment connector configuration
Update IBAN
List all transaction invoices
Retrieve a transaction invoice
Check if a transaction invoice can be replaced
Retrieve an invoice document
Search transaction invoices
Derecognize a transaction invoice
Create an instant invoice payment URL
Mark a transaction invoice as paid
Replace a transaction invoice
List all join partnerships
Retrieve a join partnership
Search join partnerships
Create a join account partnership
Create a join platform partnership
Create a join partnership for an existing merchant
Delete a join partnership
Retrieve a join admin partner configuration
Create a join admin partner configuration
Update a join admin partner configuration
Delete a join admin partner configuration
List all label descriptors
Retrieve a label descriptor
List all label descriptor groups
Retrieve a label descriptor group
Search label descriptor groups
Search label descriptors
List all languages
Retrieve a language
Search languages
List all ledger entries
Retrieve a ledger entry
Search ledger entries
Create a ledger entry
List all legal organization forms
Retrieve a legal organization form
Search legal organization forms
List all transaction line item versions
Retrieve a transaction line item version
Search transaction line item versions
Create a transaction line item version
List all manual tasks
Retrieve a manual task
Retrieve a manual task's notification message
Search manual tasks
Process a manual task's action
List all members of the account
List all members of the scope
List all members of the space
Retrieve a merchant application status
Return merchant application submission URL
Create a merchant application
Update a merchant application
List all metric usage reports
Retrieve a metric usage report
Search metric usage reports
Create a metric usage report
List all metrics
Retrieve a metric
Search metrics
Create a metric
Update a metric
Delete a metric
List all OAuth Clients
Retrieve an OAuth Client
Search OAuth Clients
Create a OAuth Client
Generate a new client secret
Update a OAuth Client
Deactivate a client secret
Delete a OAuth Client
List all OAuth Consents
Retrieve an OAuth Consent
Search OAuth Consents
Revoke an OAuth Consent
List all payment connector configurations
Retrieve a payment connector configuration
Search payment connector configurations
Create a payment connector configuration
Update a payment connector configuration
Delete a payment connector configuration
List all payment connectors.
Retrieve a payment connector.
Search payment connectors.
List all payment links
Retrieve a payment link
Search payment links
Create a payment link
Update a payment link
Delete a payment link
List all payment method brands.
Retrieve a payment method brand.
Search payment method brands.
List all payment method configurations
Retrieve a payment method configuration
Search payment method configurations
Create a payment method configuration
Update a payment method configuration
Delete a payment method configuration
List all payment methods.
Retrieve a payment method.
Search payment methods.
List all payment processor configurations
Retrieve a payment processor configuration
Search payment processor configurations
Create a payment processor configuration
Link a contract with a payment processor configuration
Update a payment processor configuration
Delete a payment processor configuration
List all payment processors.
Retrieve a payment processor.
Search payment processors.
Create a processor
Activate a processor for production
Create a connector
Update a charge attempt
Update a completion
Update a connector
Update a processor
Update a refund
Update a void
Delete a connector
Delete a processor
List all permissions
Retrieve a permission
Search permissions
List all component groups
Retrieve a component group
Search component groups
Create a component group
Update a component group
Delete a component group
List all components
Retrieve a component
Search components
Create a component
Update a component
Delete a component
List all metered fee tiers
Retrieve a metered fee tier
Search metered fee tiers
Create a metered fee tier
Update a metered fee tier
Delete a metered fee tier
List all metered fees
Retrieve a metered fee
Search metered fees
Create a metered fee
Update a metered fee
Delete a metered fee
List all period fees
Retrieve a period fee
Search period fees
Create a period fee
Update a period fee
Delete a period fee
List all product retirements
Retrieve a product retirement
Search product retirements
List all setup fees
Retrieve a setup fee
Search setup fees
Create a setup fee
Update a setup fee
Delete a setup fee
List all product version retirements
Retrieve a product version retirement
Search product version retirements
List all product versions
Retrieve a product version
Search product versions
Create a product version
Activate a product version
Retire a product version
Update a product version
List all products
Retrieve a product
Search products
Create a product
Retire a product
Update a product
List all refund bank transactions
Retrieve a refund bank transaction
Search refund bank transactions
List all refund comments
Retrieve a refund comment
Search refund comments
Create a refund comment
Pin a comment to the top
Remove the pinned comment from the top
Update a refund comment
Delete a refund comment
List all refund recovery bank transactions
Retrieve a refund recovery bank transaction
Search refund recovery bank transactions
List all refunds
Retrieve a refund
Retrieve a refund document
Search refunds
Create a refund
Mark a refund as failed
Mark a refund as successful
List all roles
Retrieve a role
Search roles
Create a role
Update a role
Delete a role
List all payment sales channels.
Retrieve a payment sales channel.
Search payment sales channels.
List all single sign-on users
Retrieve a single sign-on user
Search single sign-on users
Create a single sign-on user
Update a single sign-on user
Delete a single sign-on user
List all spaces
Retrieve a space
Search spaces
Create a space
Update a space
Delete a space
List all static values
Retrieve a static value
Search static values
List all subscribers
Retrieve a subscriber
Search subscribers
Create a subscriber
Update a subscriber
Delete a subscriber
List all affiliates
Retrieve an affiliate
Search affiliates
Create an affiliate
Update an affiliate
Delete an affiliate
List all charges
Retrieve a charge
Search charges
Create a charge
Discard a charge
List all subscription period bills
Retrieve a subscription period bill
Search subscription period bills
Close a subscription period bill
List all subscription versions
Retrieve a subscription version
Search subscription versions
List all subscriptions
Retrieve a subscription
Search subscription invoices
Search subscriptions
Create a subscription
Apply changes to a subscription
Initialize a subscription
Initialize a subscription with the subscriber present
Reactivate a suspended subscription
Suspend a subscription
Terminate a subscription
Upgrade a subscription's product
Update a subscription
List all suspensions
Retrieve a suspension
Search suspensions
List terminal locations
Retrieve a terminal location
List all summaries
Retrieve a summary
Retrieve a rendered summary receipt
Search summaries
List all payment terminals
Retrieve a payment terminal
Retrieve till connection credentials
Search payment terminal activation status
Search payment terminals
Create a payment terminal
Link a device with a payment terminal
Perform a payment terminal transaction
Refresh a physical terminal state
Remotely trigger the configuration
Remotely trigger the final balance
Unlink any device from a payment terminal
Perform a payment terminal transaction by identifier
Refresh a physical terminal state by identifier
Remotely trigger the configuration by identifier
Remotely trigger the final balance by identifier
Revert terminal transaction
Update a payment terminal
Delete a payment terminal
List all token versions
Retrieve a token version
Search token token versions
List all tokens
Retrieve a token
Retrieve the active token version
Search tokens
Create a token
Create a transaction for token update
Update a token
Delete a token
List all transaction comments
Retrieve a transaction comment
Search transaction comments
Create a transaction comment
Pin a comment to the top
Remove the pinned comment from the top
Update a transaction comment
Delete a transaction comment
List all transaction voids
Retrieve a transaction void
Search transaction voids
List all transactions
Retrieve a transaction
Retrieve a charge flow payment page URL
Check if token can be created
Retrieve transaction credentials
Retrieve an iFrame JavaScript URL
Retrieve an invoice document
Retrieve the latest line item version
Retrieve a Lightbox JavaScript URL
Retrieve a transaction overview
Retrieve a packing slip document
List available payment method configurations
Retrieve a payment page URL
Retrieve the successful charge attempt
List terminal receipts
Retrieve a transaction by credentials
Retrieve a Mobile SDK URL by credentials
List one-click tokens by credentials
List available payment method configurations by credentials
Export transactions
Search transactions
Create a transaction
Process a transaction via charge flow
Cancel a charge flow
Update a charge flow recipient
Complete a transaction offline
Complete a transaction online
Complete a transaction offline partially
Complete a transaction online partially
Confirm a transaction
Process a card transaction
Process a card transaction with 3-D Secure
Process a transaction via token
Process a transaction without user-interaction
Void a transaction offline
Void a transaction online
Process via one-click token by credentials
Update a transaction
Delete a one-click token by credentials
Create account UI theme
Delete account UI theme
Delete account theme logo
Retrieve a webhook encryption key
List all webhook listeners
Retrieve a webhook listener
Search webhook listeners
Create a webhook listener
Create multiple webhook listeners
Update a webhook listener
Update multiple webhook listeners
Delete a webhook listener
Delete multiple webhook listeners
List all webhook URLs
Retrieve a webhook URL
Search webhook URLs
Create a webhook URL
Create multiple webhook URLs
Update a webhook URL
Update multiple webhook URLs
Delete a webhook URL
Delete multiple webhook URLs
DELETE
/api/v2.0/oauth2/clients/{clientId}/secrets/{id}
Documentation
Send
Careful!
This is a live request, sending it can result in actual changes.
Parameters
clientId
Long
Required
PATH
id
Long
Required
PATH
Staging
2.229.0