Wallee Ruby SDK

• API version: 2.0

The Wallee Ruby SDK is used to interact with Wallee's REST API.

Requirements

Ruby 3.2.0 or later.

Installation

gem install (recommended)

gem install wallee-ruby-sdk

Getting Started

Please follow the installation instructions, then run the following example:

require 'wallee-ruby-sdk'

application_user_id = '512'
authentication_key = 'FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ='

WalleeRubySdk.configure do |config|
  config.user_id = application_user_id
  config.authentication_key = authentication_key
end

transactions_service = WalleeRubySdk::TransactionsService.new

space_id = '405'
transaction_id = 367155626
expand_set = ['group']

begin
  transaction = transactions_service.get_payment_transactions_id(
    transaction_id,
    space_id,
    { expand: expand_set }
  )
  puts "Transaction:"
  puts transaction
rescue Exception => e
  puts "Exception when calling api: #{e}"
end

Documentation for API Endpoints

Additional API services documentation: link
Web API client: link

Click here to see full list of services

All URIs are relative to https://app-wallee.com/

API Services:

- AccountsService
  * delete_accounts_id     DELETE /accounts/id     Delete an account

- AccountsService
  * get_accounts     GET /accounts     List all accounts

- AccountsService
  * get_accounts_id     GET /accounts/id     Retrieve an account

- AccountsService
  * get_accounts_search     GET /accounts/search     Search accounts

- AccountsService
  * patch_accounts_id     PATCH /accounts/id     Update an account

- AccountsService
  * post_accounts     POST /accounts     Create an account

- AccountsService
  * post_accounts_id_activate     POST /accounts/id/activate     Activate an account

- AccountsService
  * post_accounts_id_deactivate     POST /accounts/id/deactivate     Deactivate an account

- AnalyticsQueriesService
  * delete_analytics_queries_query_external_id_query_external_id     DELETE /analytics/queries/queryExternalId/queryExternalId     Cancel a query execution, identifying it by its external id.

- AnalyticsQueriesService
  * delete_analytics_queries_query_token_query_token     DELETE /analytics/queries/queryToken/queryToken     Cancel a query execution, identifying it by its query token.

- AnalyticsQueriesService
  * get_analytics_queries     GET /analytics/queries     Get portion of query executions for account

- AnalyticsQueriesService
  * get_analytics_queries_query_external_id_query_external_id     GET /analytics/queries/queryExternalId/queryExternalId     Retrieve a query execution information by its external id

- AnalyticsQueriesService
  * get_analytics_queries_query_external_id_query_external_id_result     GET /analytics/queries/queryExternalId/queryExternalId/result     Generate a temporary URL to download the query result. It retrieves the query by its external id

- AnalyticsQueriesService
  * get_analytics_queries_query_token_query_token     GET /analytics/queries/queryToken/queryToken     Retrieve a query execution information by its query token

- AnalyticsQueriesService
  * get_analytics_queries_query_token_query_token_result     GET /analytics/queries/queryToken/queryToken/result     Generate a temporary URL to download the query result. It retrieves the query by its query token

- AnalyticsQueriesService
  * post_analytics_queries_submit     POST /analytics/queries/submit     Submit a query execution

- ApplicationUsersService
  * delete_application_users_id     DELETE /application-users/id     Delete an application user

- ApplicationUsersService
  * delete_application_users_user_id_keys_id     DELETE /application-users/userId/keys/id     Deactivate an authentication key

- ApplicationUsersService
  * get_application_users     GET /application-users     List all application users

- ApplicationUsersService
  * get_application_users_id     GET /application-users/id     Retrieve an application user

- ApplicationUsersService
  * get_application_users_search     GET /application-users/search     Search application users

- ApplicationUsersService
  * get_application_users_user_id_keys     GET /application-users/userId/keys     List a user's authentication keys

- ApplicationUsersService
  * patch_application_users_id     PATCH /application-users/id     Update an application user

- ApplicationUsersService
  * post_application_users     POST /application-users     Create an application user

- ApplicationUsersService
  * post_application_users_user_id_keys     POST /application-users/userId/keys     Generate a new authentication key

- ApplicationUsersRolesService
  * delete_application_users_user_id_account_roles     DELETE /application-users/userId/account-roles     Unassign a role from an application user for an account

- ApplicationUsersRolesService
  * delete_application_users_user_id_space_roles     DELETE /application-users/userId/space-roles     Unassign a role from an application user for a space

- ApplicationUsersRolesService
  * get_application_users_user_id_account_roles     GET /application-users/userId/account-roles     List all roles of an application user for an account

- ApplicationUsersRolesService
  * get_application_users_user_id_space_roles     GET /application-users/userId/space-roles     List all roles of an application user for a space

- ApplicationUsersRolesService
  * post_application_users_user_id_account_roles     POST /application-users/userId/account-roles     Assign a role to an application user for an account

- ApplicationUsersRolesService
  * post_application_users_user_id_space_roles     POST /application-users/userId/space-roles     Assign a role to an application user for a space

- BankAccountsService
  * get_payment_bank_accounts     GET /payment/bank-accounts     List all bank accounts

- BankAccountsService
  * get_payment_bank_accounts_id     GET /payment/bank-accounts/id     Retrieve a bank account

- BankAccountsService
  * get_payment_bank_accounts_search     GET /payment/bank-accounts/search     Search bank accounts

- BankTransactionsService
  * get_payment_bank_transactions     GET /payment/bank-transactions     List all bank transactions

- BankTransactionsService
  * get_payment_bank_transactions_id     GET /payment/bank-transactions/id     Retrieve a bank transaction

- BankTransactionsService
  * get_payment_bank_transactions_search     GET /payment/bank-transactions/search     Search bank transactions

- ChargeAttemptsService
  * get_payment_charge_attempts     GET /payment/charge-attempts     List all charge attempts

- ChargeAttemptsService
  * get_payment_charge_attempts_id     GET /payment/charge-attempts/id     Retrieve a charge attempt

- ChargeAttemptsService
  * get_payment_charge_attempts_search     GET /payment/charge-attempts/search     Search charge attempts

- ChargeBankTransactionsService
  * get_payment_bank_transactions_charges     GET /payment/bank-transactions/charges     List all charge bank transactions

- ChargeBankTransactionsService
  * get_payment_bank_transactions_charges_id     GET /payment/bank-transactions/charges/id     Retrieve a charge bank transaction

- ChargeBankTransactionsService
  * get_payment_bank_transactions_charges_search     GET /payment/bank-transactions/charges/search     Search charge bank transactions

- ChargeFlowLevelsService
  * get_payment_charge_flows_levels     GET /payment/charge-flows/levels     List all charge flow levels

- ChargeFlowLevelsService
  * get_payment_charge_flows_levels_id     GET /payment/charge-flows/levels/id     Retrieve a charge flow level

- ChargeFlowLevelsService
  * get_payment_charge_flows_levels_search     GET /payment/charge-flows/levels/search     Search charge flow levels

- ChargeFlowLevelsService
  * post_payment_charge_flows_levels_id_send_message     POST /payment/charge-flows/levels/id/send-message     Send a payment link

- ChargeFlowsService
  * get_payment_charge_flows     GET /payment/charge-flows     List all charge flows

- ChargeFlowsService
  * get_payment_charge_flows_id     GET /payment/charge-flows/id     Retrieve a charge flow

- ChargeFlowsService
  * get_payment_charge_flows_search     GET /payment/charge-flows/search     Search charge flows

- ChargeFlowsLevelPaymentLinksService
  * get_payment_charge_flows_levels_payment_links     GET /payment/charge-flows/levels/payment-links     List all charge flow payment links

- ChargeFlowsLevelPaymentLinksService
  * get_payment_charge_flows_levels_payment_links_id     GET /payment/charge-flows/levels/payment-links/id     Retrieve a charge flow payment link

- ChargeFlowsLevelPaymentLinksService
  * get_payment_charge_flows_levels_payment_links_search     GET /payment/charge-flows/levels/payment-links/search     Search charge flow payment links

- ConditionTypesService
  * get_payment_condition_types     GET /payment/condition-types     List all condition types.

- ConditionTypesService
  * get_payment_condition_types_id     GET /payment/condition-types/id     Retrieve a condition type.

- ConditionTypesService
  * get_payment_condition_types_search     GET /payment/condition-types/search     Search condition types.

- ConsumedResourcesService
  * get_spaces_consumed_resources     GET /spaces/consumed-resources     List consumed resources

- CountriesService
  * get_countries     GET /countries     List all countries

- CountriesService
  * get_countries_code     GET /countries/code     Retrieve a country

- CountriesService
  * get_countries_country_code_states     GET /countries/countryCode/states     List all states for a country

- CountriesService
  * get_countries_search     GET /countries/search     Search countries

- CountriesService
  * get_countries_states     GET /countries/states     List all country states

- CountriesService
  * get_countries_states_id     GET /countries/states/id     Retrieve a country state

- CurrenciesService
  * get_currencies     GET /currencies     List all currencies

- CurrenciesService
  * get_currencies_code     GET /currencies/code     Retrieve a currency

- CurrenciesService
  * get_currencies_search     GET /currencies/search     Search currencies

- CurrencyBankAccountsService
  * get_payment_currency_bank_accounts     GET /payment/currency-bank-accounts     List all currency bank accounts

- CurrencyBankAccountsService
  * get_payment_currency_bank_accounts_id     GET /payment/currency-bank-accounts/id     Retrieve a currency bank account

- CurrencyBankAccountsService
  * get_payment_currency_bank_accounts_search     GET /payment/currency-bank-accounts/search     Search currency bank accounts

- CustomerAddressesService
  * delete_customers_customer_id_addresses_id     DELETE /customers/customerId/addresses/id     Delete a customer address

- CustomerAddressesService
  * get_customers_customer_id_addresses     GET /customers/customerId/addresses     List all customer addresses

- CustomerAddressesService
  * get_customers_customer_id_addresses_id     GET /customers/customerId/addresses/id     Retrieve a customer address

- CustomerAddressesService
  * get_customers_customer_id_addresses_search     GET /customers/customerId/addresses/search     Search customer addresses

- CustomerAddressesService
  * patch_customers_customer_id_addresses_id     PATCH /customers/customerId/addresses/id     Update a customer address

- CustomerAddressesService
  * post_customers_customer_id_addresses     POST /customers/customerId/addresses     Create a customer address

- CustomerAddressesService
  * post_customers_customer_id_addresses_id_default     POST /customers/customerId/addresses/id/default     Set the default address for a customer

- CustomerCommentsService
  * delete_customers_customer_id_comments_id     DELETE /customers/customerId/comments/id     Delete a customer comment

- CustomerCommentsService
  * get_customers_customer_id_comments     GET /customers/customerId/comments     List all customer comments

- CustomerCommentsService
  * get_customers_customer_id_comments_id     GET /customers/customerId/comments/id     Retrieve a customer comment

- CustomerCommentsService
  * get_customers_customer_id_comments_search     GET /customers/customerId/comments/search     Search customer comments

- CustomerCommentsService
  * patch_customers_customer_id_comments_id     PATCH /customers/customerId/comments/id     Update a customer comment

- CustomerCommentsService
  * post_customers_customer_id_comments     POST /customers/customerId/comments     Create a customer comment

- CustomerCommentsService
  * post_customers_customer_id_comments_id_pin     POST /customers/customerId/comments/id/pin     Pin a comment to the top

- CustomerCommentsService
  * post_customers_customer_id_comments_id_unpin     POST /customers/customerId/comments/id/unpin     Remove a pinned comment from the top

- CustomersService
  * delete_customers_bulk     DELETE /customers/bulk     Delete multiple customers

- CustomersService
  * delete_customers_id     DELETE /customers/id     Delete a customer

- CustomersService
  * get_customers     GET /customers     List all customers

- CustomersService
  * get_customers_id     GET /customers/id     Retrieve a customer

- CustomersService
  * get_customers_id_email_addresses     GET /customers/id/email-addresses     List a customer's email addresses

- CustomersService
  * get_customers_search     GET /customers/search     Search customers

- CustomersService
  * patch_customers_bulk     PATCH /customers/bulk     Update multiple customers

- CustomersService
  * patch_customers_id     PATCH /customers/id     Update a customer

- CustomersService
  * post_customers     POST /customers     Create a customer

- CustomersService
  * post_customers_bulk     POST /customers/bulk     Create multiple customers

- CustomersService
  * post_customers_id_merge_other     POST /customers/id/merge/other     Merge two customers

- DebtCollectionCasesService
  * delete_debt_collection_cases_id     DELETE /debt-collection/cases/id     Delete a debt collection case

- DebtCollectionCasesService
  * get_debt_collection_cases     GET /debt-collection/cases     List all debt collection cases

- DebtCollectionCasesService
  * get_debt_collection_cases_id     GET /debt-collection/cases/id     Retrieve a debt collection case

- DebtCollectionCasesService
  * get_debt_collection_cases_id_documents     GET /debt-collection/cases/id/documents     Retrieve all documents of a debt collection case

- DebtCollectionCasesService
  * get_debt_collection_cases_search     GET /debt-collection/cases/search     Search debt collection cases

- DebtCollectionCasesService
  * patch_debt_collection_cases_id     PATCH /debt-collection/cases/id     Update a debt collection case

- DebtCollectionCasesService
  * post_debt_collection_cases     POST /debt-collection/cases     Create a debt collection case

- DebtCollectionCasesService
  * post_debt_collection_cases_id_close     POST /debt-collection/cases/id/close     Close a debt collection case

- DebtCollectionCasesService
  * post_debt_collection_cases_id_documents     POST /debt-collection/cases/id/documents     Attach a document to a debt collection case

- DebtCollectionCasesService
  * post_debt_collection_cases_id_mark_prepared     POST /debt-collection/cases/id/mark-prepared     Mark a debt collection case as prepared

- DebtCollectionCasesService
  * post_debt_collection_cases_id_mark_reviewed     POST /debt-collection/cases/id/mark-reviewed     Mark a debt collection case as reviewed

- DebtCollectionCasesService
  * post_debt_collection_cases_id_payment_receipts     POST /debt-collection/cases/id/payment-receipts     Create a payment receipt for a debt collection case

- DebtCollectorConfigurationsService
  * delete_debt_collection_configurations_id     DELETE /debt-collection/configurations/id     Delete a debt collector configuration

- DebtCollectorConfigurationsService
  * get_debt_collection_configurations     GET /debt-collection/configurations     List all debt collector configurations

- DebtCollectorConfigurationsService
  * get_debt_collection_configurations_id     GET /debt-collection/configurations/id     Retrieve a debt collector configuration

- DebtCollectorConfigurationsService
  * get_debt_collection_configurations_search     GET /debt-collection/configurations/search     Search debt collector configurations

- DebtCollectorConfigurationsService
  * patch_debt_collection_configurations_id     PATCH /debt-collection/configurations/id     Update a debt collector configuration

- DebtCollectorConfigurationsService
  * post_debt_collection_configurations     POST /debt-collection/configurations     Create a debt collector configuration

- DebtCollectorsService
  * get_debt_collection_collectors     GET /debt-collection/collectors     List all debt collectors

- DebtCollectorsService
  * get_debt_collection_collectors_id     GET /debt-collection/collectors/id     Retrieve a debt collector

- DebtCollectorsService
  * get_debt_collection_collectors_search     GET /debt-collection/collectors/search     Search debt collectors

- DeliveryIndicationsService
  * get_payment_delivery_indications     GET /payment/delivery-indications     List all delivery indications

- DeliveryIndicationsService
  * get_payment_delivery_indications_id     GET /payment/delivery-indications/id     Retrieve a delivery indication

- DeliveryIndicationsService
  * get_payment_delivery_indications_search     GET /payment/delivery-indications/search     Search delivery indications

- DeliveryIndicationsService
  * post_payment_delivery_indications_id_mark_not_suitable     POST /payment/delivery-indications/id/mark-not-suitable     Mark a delivery indication as not suitable.

- DeliveryIndicationsService
  * post_payment_delivery_indications_id_mark_suitable     POST /payment/delivery-indications/id/mark-suitable     Mark a delivery indication as suitable.

- DocumentTemplateTypesService
  * get_document_templates_types     GET /document-templates/types     List all document template types

- DocumentTemplateTypesService
  * get_document_templates_types_id     GET /document-templates/types/id     Retrieve a document template type

- DocumentTemplateTypesService
  * get_document_templates_types_search     GET /document-templates/types/search     Search document template types

- DocumentTemplatesService
  * get_document_templates     GET /document-templates     List all document templates

- DocumentTemplatesService
  * get_document_templates_id     GET /document-templates/id     Retrieve a document template

- DocumentTemplatesService
  * get_document_templates_search     GET /document-templates/search     Search document templates

- DunningCasesService
  * get_payment_dunning_cases     GET /payment/dunning-cases     List all dunning cases

- DunningCasesService
  * get_payment_dunning_cases_id     GET /payment/dunning-cases/id     Retrieve a dunning case

- DunningCasesService
  * get_payment_dunning_cases_search     GET /payment/dunning-cases/search     Search dunning cases

- DunningCasesService
  * post_payment_dunning_cases_id_suspend     POST /payment/dunning-cases/id/suspend     Suspend a dunning case

- DunningCasesService
  * post_payment_dunning_cases_invoice_invoice_id     POST /payment/dunning-cases/invoice/invoiceId     Create a dunning case for an invoice

- DunningFlowLevelsService
  * get_payment_dunning_flows_levels     GET /payment/dunning-flows/levels     List all dunning flow levels

- DunningFlowLevelsService
  * get_payment_dunning_flows_levels_id     GET /payment/dunning-flows/levels/id     Retrieve a dunning flow level

- DunningFlowLevelsService
  * get_payment_dunning_flows_levels_search     GET /payment/dunning-flows/levels/search     Search dunning flow levels

- DunningFlowsService
  * get_payment_dunning_flows     GET /payment/dunning-flows     List all dunning flows

- DunningFlowsService
  * get_payment_dunning_flows_id     GET /payment/dunning-flows/id     Retrieve a dunning flow

- DunningFlowsService
  * get_payment_dunning_flows_search     GET /payment/dunning-flows/search     Search dunning flows

- ExpressCheckoutService
  * post_express_checkout_create_session     POST /express-checkout/create-session     Create a new Express Checkout Session

- ExternalTransferBankTransactionsService
  * get_payment_bank_transactions_external_transfers     GET /payment/bank-transactions/external-transfers     List all external transfer bank transactions

- ExternalTransferBankTransactionsService
  * get_payment_bank_transactions_external_transfers_id     GET /payment/bank-transactions/external-transfers/id     Retrieve an external transfer bank transaction

- ExternalTransferBankTransactionsService
  * get_payment_bank_transactions_external_transfers_search     GET /payment/bank-transactions/external-transfers/search     Search external transfer bank transactions

- HumanUsersService
  * delete_human_users_id     DELETE /human-users/id     Delete a human user

- HumanUsersService
  * get_human_users     GET /human-users     List all human users

- HumanUsersService
  * get_human_users_export     GET /human-users/export     Export human users

- HumanUsersService
  * get_human_users_id     GET /human-users/id     Retrieve a human user

- HumanUsersService
  * get_human_users_search     GET /human-users/search     Search human users

- HumanUsersService
  * patch_human_users_id     PATCH /human-users/id     Update a human user

- HumanUsersService
  * post_human_users     POST /human-users     Create a human user

- HumanUsersRolesService
  * delete_human_users_user_id_account_roles     DELETE /human-users/userId/account-roles     Unassign a role from a human user for an account

- HumanUsersRolesService
  * delete_human_users_user_id_space_roles     DELETE /human-users/userId/space-roles     Unassign a role from a human user for a space

- HumanUsersRolesService
  * get_human_users_user_id_account_roles     GET /human-users/userId/account-roles     List all roles of a human user for an account

- HumanUsersRolesService
  * get_human_users_user_id_space_roles     GET /human-users/userId/space-roles     List all roles of a human user for a space

- HumanUsersRolesService
  * post_human_users_user_id_account_roles     POST /human-users/userId/account-roles     Assign a role to a human user for an account

- HumanUsersRolesService
  * post_human_users_user_id_space_roles     POST /human-users/userId/space-roles     Assign a role to a human user for a space

- InternalTransferBankTransactionsService
  * get_payment_bank_transactions_internal_transfers     GET /payment/bank-transactions/internal-transfers     List all internal transfer bank transactions

- InternalTransferBankTransactionsService
  * get_payment_bank_transactions_internal_transfers_id     GET /payment/bank-transactions/internal-transfers/id     Retrieve an internal transfer bank transaction

- InternalTransferBankTransactionsService
  * get_payment_bank_transactions_internal_transfers_search     GET /payment/bank-transactions/internal-transfers/search     Search internal transfer bank transactions

- LabelDescriptorsService
  * get_label_descriptors     GET /label-descriptors     List all label descriptors

- LabelDescriptorsService
  * get_label_descriptors_groups     GET /label-descriptors/groups     List all label descriptor groups

- LabelDescriptorsService
  * get_label_descriptors_groups_id     GET /label-descriptors/groups/id     Retrieve a label descriptor group

- LabelDescriptorsService
  * get_label_descriptors_groups_search     GET /label-descriptors/groups/search     Search label descriptor groups

- LabelDescriptorsService
  * get_label_descriptors_id     GET /label-descriptors/id     Retrieve a label descriptor

- LabelDescriptorsService
  * get_label_descriptors_search     GET /label-descriptors/search     Search label descriptors

- LanguagesService
  * get_languages     GET /languages     List all languages

- LanguagesService
  * get_languages_code     GET /languages/code     Retrieve a language

- LanguagesService
  * get_languages_search     GET /languages/search     Search languages

- LegalOrganizationFormsService
  * get_legal_organization_forms     GET /legal-organization-forms     List all legal organization forms

- LegalOrganizationFormsService
  * get_legal_organization_forms_id     GET /legal-organization-forms/id     Retrieve a legal organization form

- LegalOrganizationFormsService
  * get_legal_organization_forms_search     GET /legal-organization-forms/search     Search legal organization forms

- ManualTasksService
  * get_manual_tasks     GET /manual-tasks     List all manual tasks

- ManualTasksService
  * get_manual_tasks_id     GET /manual-tasks/id     Retrieve a manual task

- ManualTasksService
  * get_manual_tasks_id_notification     GET /manual-tasks/id/notification     Retrieve a manual task's notification message

- ManualTasksService
  * get_manual_tasks_search     GET /manual-tasks/search     Search manual tasks

- ManualTasksService
  * post_manual_tasks_id_action_action_id     POST /manual-tasks/id/action/actionId     Process a manual task's action

- PaymentConnectorConfigurationsService
  * delete_payment_connector_configurations_id     DELETE /payment/connector-configurations/id     Delete a payment connector configuration

- PaymentConnectorConfigurationsService
  * get_payment_connector_configurations     GET /payment/connector-configurations     List all payment connector configurations

- PaymentConnectorConfigurationsService
  * get_payment_connector_configurations_id     GET /payment/connector-configurations/id     Retrieve a payment connector configuration

- PaymentConnectorConfigurationsService
  * get_payment_connector_configurations_search     GET /payment/connector-configurations/search     Search payment connector configurations

- PaymentConnectorConfigurationsService
  * patch_payment_connector_configurations_id     PATCH /payment/connector-configurations/id     Update a payment connector configuration

- PaymentConnectorConfigurationsService
  * post_payment_connector_configurations     POST /payment/connector-configurations     Create a payment connector configuration

- PaymentConnectorsService
  * get_payment_connectors     GET /payment/connectors     List all payment connectors.

- PaymentConnectorsService
  * get_payment_connectors_id     GET /payment/connectors/id     Retrieve a payment connector.

- PaymentConnectorsService
  * get_payment_connectors_search     GET /payment/connectors/search     Search payment connectors.

- PaymentLinksService
  * delete_payment_links_id     DELETE /payment/links/id     Delete a payment link

- PaymentLinksService
  * get_payment_links     GET /payment/links     List all payment links

- PaymentLinksService
  * get_payment_links_id     GET /payment/links/id     Retrieve a payment link

- PaymentLinksService
  * get_payment_links_search     GET /payment/links/search     Search payment links

- PaymentLinksService
  * patch_payment_links_id     PATCH /payment/links/id     Update a payment link

- PaymentLinksService
  * post_payment_links     POST /payment/links     Create a payment link

- PaymentMethodBrandsService
  * get_payment_method_brands     GET /payment/method-brands     List all payment method brands.

- PaymentMethodBrandsService
  * get_payment_method_brands_id     GET /payment/method-brands/id     Retrieve a payment method brand.

- PaymentMethodBrandsService
  * get_payment_method_brands_search     GET /payment/method-brands/search     Search payment method brands.

- PaymentMethodConfigurationsService
  * delete_payment_method_configurations_id     DELETE /payment/method-configurations/id     Delete a payment method configuration

- PaymentMethodConfigurationsService
  * get_payment_method_configurations     GET /payment/method-configurations     List all payment method configurations

- PaymentMethodConfigurationsService
  * get_payment_method_configurations_id     GET /payment/method-configurations/id     Retrieve a payment method configuration

- PaymentMethodConfigurationsService
  * get_payment_method_configurations_search     GET /payment/method-configurations/search     Search payment method configurations

- PaymentMethodConfigurationsService
  * patch_payment_method_configurations_id     PATCH /payment/method-configurations/id     Update a payment method configuration

- PaymentMethodConfigurationsService
  * post_payment_method_configurations     POST /payment/method-configurations     Create a payment method configuration

- PaymentMethodsService
  * get_payment_methods     GET /payment/methods     List all payment methods.

- PaymentMethodsService
  * get_payment_methods_id     GET /payment/methods/id     Retrieve a payment method.

- PaymentMethodsService
  * get_payment_methods_search     GET /payment/methods/search     Search payment methods.

- PaymentProcessorConfigurationsService
  * delete_payment_processor_configurations_id     DELETE /payment/processor-configurations/id     Delete a payment processor configuration

- PaymentProcessorConfigurationsService
  * get_payment_processor_configurations     GET /payment/processor-configurations     List all payment processor configurations

- PaymentProcessorConfigurationsService
  * get_payment_processor_configurations_id     GET /payment/processor-configurations/id     Retrieve a payment processor configuration

- PaymentProcessorConfigurationsService
  * get_payment_processor_configurations_search     GET /payment/processor-configurations/search     Search payment processor configurations

- PaymentProcessorConfigurationsService
  * patch_payment_processor_configurations_id     PATCH /payment/processor-configurations/id     Update a payment processor configuration

- PaymentProcessorConfigurationsService
  * post_payment_processor_configurations     POST /payment/processor-configurations     Create a payment processor configuration

- PaymentProcessorsService
  * get_payment_processors     GET /payment/processors     List all payment processors.

- PaymentProcessorsService
  * get_payment_processors_id     GET /payment/processors/id     Retrieve a payment processor.

- PaymentProcessorsService
  * get_payment_processors_search     GET /payment/processors/search     Search payment processors.

- PaymentSalesChannelsService
  * get_payment_sales_channels     GET /payment/sales-channels     List all payment sales channels.

- PaymentSalesChannelsService
  * get_payment_sales_channels_id     GET /payment/sales-channels/id     Retrieve a payment sales channel.

- PaymentSalesChannelsService
  * get_payment_sales_channels_search     GET /payment/sales-channels/search     Search payment sales channels.

- PaymentTerminalsService
  * delete_payment_terminals_id     DELETE /payment/terminals/id     Delete a payment terminal

- PaymentTerminalsService
  * get_payment_terminals     GET /payment/terminals     List all payment terminals

- PaymentTerminalsService
  * get_payment_terminals_id     GET /payment/terminals/id     Retrieve a payment terminal

- PaymentTerminalsService
  * get_payment_terminals_id_till_connection_credentials     GET /payment/terminals/id/till-connection-credentials     Retrieve till connection credentials

- PaymentTerminalsService
  * get_payment_terminals_search     GET /payment/terminals/search     Search payment terminals

- PaymentTerminalsService
  * patch_payment_terminals_id     PATCH /payment/terminals/id     Update a payment terminal

- PaymentTerminalsService
  * post_payment_terminals     POST /payment/terminals     Create a payment terminal

- PaymentTerminalsService
  * post_payment_terminals_by_identifier_identifier_perform_transaction     POST /payment/terminals/by-identifier/identifier/perform-transaction     Perform a payment terminal transaction by identifier

- PaymentTerminalsService
  * post_payment_terminals_by_identifier_identifier_trigger_final_balance     POST /payment/terminals/by-identifier/identifier/trigger-final-balance     Remotely trigger the final balance by identifier

- PaymentTerminalsService
  * post_payment_terminals_id_link     POST /payment/terminals/id/link     Link a device with a payment terminal

- PaymentTerminalsService
  * post_payment_terminals_id_perform_transaction     POST /payment/terminals/id/perform-transaction     Perform a payment terminal transaction

- PaymentTerminalsService
  * post_payment_terminals_id_trigger_final_balance     POST /payment/terminals/id/trigger-final-balance     Remotely trigger the final balance

- PaymentTerminalsService
  * post_payment_terminals_id_unlink     POST /payment/terminals/id/unlink     Unlink any device from a payment terminal

- PaymentWebAppsService
  * delete_payment_web_apps_connectors_connector_external_id     DELETE /payment/web-apps/connectors/connectorExternalId     Delete a connector

- PaymentWebAppsService
  * delete_payment_web_apps_processors_external_id     DELETE /payment/web-apps/processors/externalId     Delete a processor

- PaymentWebAppsService
  * patch_payment_web_apps_charge_attempts_id     PATCH /payment/web-apps/charge-attempts/id     Update a charge attempt

- PaymentWebAppsService
  * patch_payment_web_apps_completions_id     PATCH /payment/web-apps/completions/id     Update a completion

- PaymentWebAppsService
  * patch_payment_web_apps_connectors_connector_external_id     PATCH /payment/web-apps/connectors/connectorExternalId     Update a connector

- PaymentWebAppsService
  * patch_payment_web_apps_processors_external_id     PATCH /payment/web-apps/processors/externalId     Update a processor

- PaymentWebAppsService
  * patch_payment_web_apps_refunds_id     PATCH /payment/web-apps/refunds/id     Update a refund

- PaymentWebAppsService
  * patch_payment_web_apps_voids_id     PATCH /payment/web-apps/voids/id     Update a void

- PaymentWebAppsService
  * post_payment_web_apps_processors     POST /payment/web-apps/processors     Create a processor

- PaymentWebAppsService
  * post_payment_web_apps_processors_external_id_activate_for_production     POST /payment/web-apps/processors/externalId/activate-for-production     Activate a processor for production

- PaymentWebAppsService
  * post_payment_web_apps_processors_external_id_connectors     POST /payment/web-apps/processors/externalId/connectors     Create a connector

- PermissionsService
  * get_permissions     GET /permissions     List all permissions

- PermissionsService
  * get_permissions_id     GET /permissions/id     Retrieve a permission

- PermissionsService
  * get_permissions_search     GET /permissions/search     Search permissions

- RefundBankTransactionsService
  * get_payment_bank_transactions_refunds     GET /payment/bank-transactions/refunds     List all refund bank transactions

- RefundBankTransactionsService
  * get_payment_bank_transactions_refunds_id     GET /payment/bank-transactions/refunds/id     Retrieve a refund bank transaction

- RefundBankTransactionsService
  * get_payment_bank_transactions_refunds_search     GET /payment/bank-transactions/refunds/search     Search refund bank transactions

- RefundCommentsService
  * delete_payment_refunds_refund_id_comments_id     DELETE /payment/refunds/refundId/comments/id     Delete a refund comment

- RefundCommentsService
  * get_payment_refunds_refund_id_comments     GET /payment/refunds/refundId/comments     List all refund comments

- RefundCommentsService
  * get_payment_refunds_refund_id_comments_id     GET /payment/refunds/refundId/comments/id     Retrieve a refund comment

- RefundCommentsService
  * get_payment_refunds_refund_id_comments_search     GET /payment/refunds/refundId/comments/search     Search refund comments

- RefundCommentsService
  * patch_payment_refunds_refund_id_comments_id     PATCH /payment/refunds/refundId/comments/id     Update a refund comment

- RefundCommentsService
  * post_payment_refunds_refund_id_comments     POST /payment/refunds/refundId/comments     Create a refund comment

- RefundCommentsService
  * post_payment_refunds_refund_id_comments_id_pin     POST /payment/refunds/refundId/comments/id/pin     Pin a comment to the top

- RefundCommentsService
  * post_payment_refunds_refund_id_comments_id_unpin     POST /payment/refunds/refundId/comments/id/unpin     Remove the pinned comment from the top

- RefundRecoveryBankTransactionsService
  * get_payment_bank_transactions_refund_recoveries     GET /payment/bank-transactions/refund-recoveries     List all refund recovery bank transactions

- RefundRecoveryBankTransactionsService
  * get_payment_bank_transactions_refund_recoveries_id     GET /payment/bank-transactions/refund-recoveries/id     Retrieve a refund recovery bank transaction

- RefundRecoveryBankTransactionsService
  * get_payment_bank_transactions_refund_recoveries_search     GET /payment/bank-transactions/refund-recoveries/search     Search refund recovery bank transactions

- RefundsService
  * get_payment_refunds     GET /payment/refunds     List all refunds

- RefundsService
  * get_payment_refunds_id     GET /payment/refunds/id     Retrieve a refund

- RefundsService
  * get_payment_refunds_id_document     GET /payment/refunds/id/document     Retrieve a refund document

- RefundsService
  * get_payment_refunds_search     GET /payment/refunds/search     Search refunds

- RefundsService
  * post_payment_refunds     POST /payment/refunds     Create a refund

- RefundsService
  * post_payment_refunds_id_mark_failed     POST /payment/refunds/id/mark-failed     Mark a refund as failed

- RefundsService
  * post_payment_refunds_id_mark_succeeded     POST /payment/refunds/id/mark-succeeded     Mark a refund as successful

- RolesService
  * delete_roles_id     DELETE /roles/id     Delete a role

- RolesService
  * get_roles     GET /roles     List all roles

- RolesService
  * get_roles_id     GET /roles/id     Retrieve a role

- RolesService
  * get_roles_search     GET /roles/search     Search roles

- RolesService
  * patch_roles_id     PATCH /roles/id     Update a role

- RolesService
  * post_roles     POST /roles     Create a role

- SingleSignOnUsersService
  * delete_single_sign_on_users_id     DELETE /single-sign-on-users/id     Delete a single sign-on user

- SingleSignOnUsersService
  * get_single_sign_on_users     GET /single-sign-on-users     List all single sign-on users

- SingleSignOnUsersService
  * get_single_sign_on_users_id     GET /single-sign-on-users/id     Retrieve a single sign-on user

- SingleSignOnUsersService
  * get_single_sign_on_users_search     GET /single-sign-on-users/search     Search single sign-on users

- SingleSignOnUsersService
  * patch_single_sign_on_users_id     PATCH /single-sign-on-users/id     Update a single sign-on user

- SingleSignOnUsersService
  * post_single_sign_on_users     POST /single-sign-on-users     Create a single sign-on user

- SingleSignOnUsersRolesService
  * delete_single_sign_on_users_user_id_account_roles     DELETE /single-sign-on-users/userId/account-roles     Unassign a role from a single sign-on user for an account

- SingleSignOnUsersRolesService
  * delete_single_sign_on_users_user_id_space_roles     DELETE /single-sign-on-users/userId/space-roles     Unassign a role from a single sign-on user for a space

- SingleSignOnUsersRolesService
  * get_single_sign_on_users_user_id_account_roles     GET /single-sign-on-users/userId/account-roles     List all roles of a single sign-on user for an account

- SingleSignOnUsersRolesService
  * get_single_sign_on_users_user_id_space_roles     GET /single-sign-on-users/userId/space-roles     List all roles of a single sign-on user for a space

- SingleSignOnUsersRolesService
  * post_single_sign_on_users_user_id_account_roles     POST /single-sign-on-users/userId/account-roles     Assign a role to a single sign-on user for an account

- SingleSignOnUsersRolesService
  * post_single_sign_on_users_user_id_space_roles     POST /single-sign-on-users/userId/space-roles     Assign a role to a single sign-on user for a space

- SpacesService
  * delete_spaces_id     DELETE /spaces/id     Delete a space

- SpacesService
  * get_spaces     GET /spaces     List all spaces

- SpacesService
  * get_spaces_id     GET /spaces/id     Retrieve a space

- SpacesService
  * get_spaces_search     GET /spaces/search     Search spaces

- SpacesService
  * patch_spaces_id     PATCH /spaces/id     Update a space

- SpacesService
  * post_spaces     POST /spaces     Create a space

- StaticValuesService
  * get_static_values     GET /static-values     List all static values

- StaticValuesService
  * get_static_values_id     GET /static-values/id     Retrieve a static value

- StaticValuesService
  * get_static_values_search     GET /static-values/search     Search static values

- SubscribersService
  * delete_subscriptions_subscribers_id     DELETE /subscriptions/subscribers/id     Delete a subscriber

- SubscribersService
  * get_subscriptions_subscribers     GET /subscriptions/subscribers     List all subscribers

- SubscribersService
  * get_subscriptions_subscribers_id     GET /subscriptions/subscribers/id     Retrieve a subscriber

- SubscribersService
  * get_subscriptions_subscribers_search     GET /subscriptions/subscribers/search     Search subscribers

- SubscribersService
  * patch_subscriptions_subscribers_id     PATCH /subscriptions/subscribers/id     Update a subscriber

- SubscribersService
  * post_subscriptions_subscribers     POST /subscriptions/subscribers     Create a subscriber

- SubscriptionAffiliatesService
  * delete_subscriptions_affiliates_id     DELETE /subscriptions/affiliates/id     Delete an affiliate

- SubscriptionAffiliatesService
  * get_subscriptions_affiliates     GET /subscriptions/affiliates     List all affiliates

- SubscriptionAffiliatesService
  * get_subscriptions_affiliates_id     GET /subscriptions/affiliates/id     Retrieve an affiliate

- SubscriptionAffiliatesService
  * get_subscriptions_affiliates_search     GET /subscriptions/affiliates/search     Search affiliates

- SubscriptionAffiliatesService
  * patch_subscriptions_affiliates_id     PATCH /subscriptions/affiliates/id     Update an affiliate

- SubscriptionAffiliatesService
  * post_subscriptions_affiliates     POST /subscriptions/affiliates     Create an affiliate

- SubscriptionChargesService
  * get_subscriptions_charges     GET /subscriptions/charges     List all charges

- SubscriptionChargesService
  * get_subscriptions_charges_id     GET /subscriptions/charges/id     Retrieve a charge

- SubscriptionChargesService
  * get_subscriptions_charges_search     GET /subscriptions/charges/search     Search charges

- SubscriptionChargesService
  * post_subscriptions_charges     POST /subscriptions/charges     Create a charge

- SubscriptionChargesService
  * post_subscriptions_charges_id_discard     POST /subscriptions/charges/id/discard     Discard a charge

- SubscriptionLedgerEntriesService
  * get_subscriptions_ledger_entries     GET /subscriptions/ledger-entries     List all ledger entries

- SubscriptionLedgerEntriesService
  * get_subscriptions_ledger_entries_id     GET /subscriptions/ledger-entries/id     Retrieve a ledger entry

- SubscriptionLedgerEntriesService
  * get_subscriptions_ledger_entries_search     GET /subscriptions/ledger-entries/search     Search ledger entries

- SubscriptionLedgerEntriesService
  * post_subscriptions_ledger_entries     POST /subscriptions/ledger-entries     Create a ledger entry

- SubscriptionMetricUsageReportsService
  * get_subscriptions_metric_usage_reports     GET /subscriptions/metric-usage-reports     List all metric usage reports

- SubscriptionMetricUsageReportsService
  * get_subscriptions_metric_usage_reports_id     GET /subscriptions/metric-usage-reports/id     Retrieve a metric usage report

- SubscriptionMetricUsageReportsService
  * get_subscriptions_metric_usage_reports_search     GET /subscriptions/metric-usage-reports/search     Search metric usage reports

- SubscriptionMetricUsageReportsService
  * post_subscriptions_metric_usage_reports     POST /subscriptions/metric-usage-reports     Create a metric usage report

- SubscriptionMetricsService
  * delete_subscriptions_metrics_id     DELETE /subscriptions/metrics/id     Delete a metric

- SubscriptionMetricsService
  * get_subscriptions_metrics     GET /subscriptions/metrics     List all metrics

- SubscriptionMetricsService
  * get_subscriptions_metrics_id     GET /subscriptions/metrics/id     Retrieve a metric

- SubscriptionMetricsService
  * get_subscriptions_metrics_search     GET /subscriptions/metrics/search     Search metrics

- SubscriptionMetricsService
  * patch_subscriptions_metrics_id     PATCH /subscriptions/metrics/id     Update a metric

- SubscriptionMetricsService
  * post_subscriptions_metrics     POST /subscriptions/metrics     Create a metric

- SubscriptionPeriodBillsService
  * get_subscriptions_period_bills     GET /subscriptions/period-bills     List all subscription period bills

- SubscriptionPeriodBillsService
  * get_subscriptions_period_bills_id     GET /subscriptions/period-bills/id     Retrieve a subscription period bill

- SubscriptionPeriodBillsService
  * get_subscriptions_period_bills_search     GET /subscriptions/period-bills/search     Search subscription period bills

- SubscriptionPeriodBillsService
  * post_subscriptions_period_bills_id_close     POST /subscriptions/period-bills/id/close     Close a subscription period bill

- SubscriptionProductComponentGroupsService
  * delete_subscriptions_products_component_groups_id     DELETE /subscriptions/products/component-groups/id     Delete a component group

- SubscriptionProductComponentGroupsService
  * get_subscriptions_products_component_groups     GET /subscriptions/products/component-groups     List all component groups

- SubscriptionProductComponentGroupsService
  * get_subscriptions_products_component_groups_id     GET /subscriptions/products/component-groups/id     Retrieve a component group

- SubscriptionProductComponentGroupsService
  * get_subscriptions_products_component_groups_search     GET /subscriptions/products/component-groups/search     Search component groups

- SubscriptionProductComponentGroupsService
  * patch_subscriptions_products_component_groups_id     PATCH /subscriptions/products/component-groups/id     Update a component group

- SubscriptionProductComponentGroupsService
  * post_subscriptions_products_component_groups     POST /subscriptions/products/component-groups     Create a component group

- SubscriptionProductComponentsService
  * delete_subscriptions_products_components_id     DELETE /subscriptions/products/components/id     Delete a component

- SubscriptionProductComponentsService
  * get_subscriptions_products_components     GET /subscriptions/products/components     List all components

- SubscriptionProductComponentsService
  * get_subscriptions_products_components_id     GET /subscriptions/products/components/id     Retrieve a component

- SubscriptionProductComponentsService
  * get_subscriptions_products_components_search     GET /subscriptions/products/components/search     Search components

- SubscriptionProductComponentsService
  * patch_subscriptions_products_components_id     PATCH /subscriptions/products/components/id     Update a component

- SubscriptionProductComponentsService
  * post_subscriptions_products_components     POST /subscriptions/products/components     Create a component

- SubscriptionProductMeteredFeeTiersService
  * delete_subscriptions_products_metered_fees_fee_id_tiers_id     DELETE /subscriptions/products/metered-fees/feeId/tiers/id     Delete a metered fee tier

- SubscriptionProductMeteredFeeTiersService
  * get_subscriptions_products_metered_fees_fee_id_tiers     GET /subscriptions/products/metered-fees/feeId/tiers     List all metered fee tiers

- SubscriptionProductMeteredFeeTiersService
  * get_subscriptions_products_metered_fees_fee_id_tiers_id     GET /subscriptions/products/metered-fees/feeId/tiers/id     Retrieve a metered fee tier

- SubscriptionProductMeteredFeeTiersService
  * get_subscriptions_products_metered_fees_fee_id_tiers_search     GET /subscriptions/products/metered-fees/feeId/tiers/search     Search metered fee tiers

- SubscriptionProductMeteredFeeTiersService
  * patch_subscriptions_products_metered_fees_fee_id_tiers_id     PATCH /subscriptions/products/metered-fees/feeId/tiers/id     Update a metered fee tier

- SubscriptionProductMeteredFeeTiersService
  * post_subscriptions_products_metered_fees_fee_id_tiers     POST /subscriptions/products/metered-fees/feeId/tiers     Create a metered fee tier

- SubscriptionProductMeteredFeesService
  * delete_subscriptions_products_metered_fees_id     DELETE /subscriptions/products/metered-fees/id     Delete a metered fee

- SubscriptionProductMeteredFeesService
  * get_subscriptions_products_metered_fees     GET /subscriptions/products/metered-fees     List all metered fees

- SubscriptionProductMeteredFeesService
  * get_subscriptions_products_metered_fees_id     GET /subscriptions/products/metered-fees/id     Retrieve a metered fee

- SubscriptionProductMeteredFeesService
  * get_subscriptions_products_metered_fees_search     GET /subscriptions/products/metered-fees/search     Search metered fees

- SubscriptionProductMeteredFeesService
  * patch_subscriptions_products_metered_fees_id     PATCH /subscriptions/products/metered-fees/id     Update a metered fee

- SubscriptionProductMeteredFeesService
  * post_subscriptions_products_metered_fees     POST /subscriptions/products/metered-fees     Create a metered fee

- SubscriptionProductPeriodFeesService
  * delete_subscriptions_products_period_fees_id     DELETE /subscriptions/products/period-fees/id     Delete a period fee

- SubscriptionProductPeriodFeesService
  * get_subscriptions_products_period_fees     GET /subscriptions/products/period-fees     List all period fees

- SubscriptionProductPeriodFeesService
  * get_subscriptions_products_period_fees_id     GET /subscriptions/products/period-fees/id     Retrieve a period fee

- SubscriptionProductPeriodFeesService
  * get_subscriptions_products_period_fees_search     GET /subscriptions/products/period-fees/search     Search period fees

- SubscriptionProductPeriodFeesService
  * patch_subscriptions_products_period_fees_id     PATCH /subscriptions/products/period-fees/id     Update a period fee

- SubscriptionProductPeriodFeesService
  * post_subscriptions_products_period_fees     POST /subscriptions/products/period-fees     Create a period fee

- SubscriptionProductRetirementsService
  * get_subscriptions_products_retirements     GET /subscriptions/products/retirements     List all product retirements

- SubscriptionProductRetirementsService
  * get_subscriptions_products_retirements_id     GET /subscriptions/products/retirements/id     Retrieve a product retirement

- SubscriptionProductRetirementsService
  * get_subscriptions_products_retirements_search     GET /subscriptions/products/retirements/search     Search product retirements

- SubscriptionProductSetupFeesService
  * delete_subscriptions_products_setup_fees_id     DELETE /subscriptions/products/setup-fees/id     Delete a setup fee

- SubscriptionProductSetupFeesService
  * get_subscriptions_products_setup_fees     GET /subscriptions/products/setup-fees     List all setup fees

- SubscriptionProductSetupFeesService
  * get_subscriptions_products_setup_fees_id     GET /subscriptions/products/setup-fees/id     Retrieve a setup fee

- SubscriptionProductSetupFeesService
  * get_subscriptions_products_setup_fees_search     GET /subscriptions/products/setup-fees/search     Search setup fees

- SubscriptionProductSetupFeesService
  * patch_subscriptions_products_setup_fees_id     PATCH /subscriptions/products/setup-fees/id     Update a setup fee

- SubscriptionProductSetupFeesService
  * post_subscriptions_products_setup_fees     POST /subscriptions/products/setup-fees     Create a setup fee

- SubscriptionProductVersionRetirementsService
  * get_subscriptions_products_versions_retirements     GET /subscriptions/products/versions/retirements     List all product version retirements

- SubscriptionProductVersionRetirementsService
  * get_subscriptions_products_versions_retirements_id     GET /subscriptions/products/versions/retirements/id     Retrieve a product version retirement

- SubscriptionProductVersionRetirementsService
  * get_subscriptions_products_versions_retirements_search     GET /subscriptions/products/versions/retirements/search     Search product version retirements

- SubscriptionProductVersionsService
  * get_subscriptions_products_versions     GET /subscriptions/products/versions     List all product versions

- SubscriptionProductVersionsService
  * get_subscriptions_products_versions_id     GET /subscriptions/products/versions/id     Retrieve a product version

- SubscriptionProductVersionsService
  * get_subscriptions_products_versions_search     GET /subscriptions/products/versions/search     Search product versions

- SubscriptionProductVersionsService
  * patch_subscriptions_products_versions_id     PATCH /subscriptions/products/versions/id     Update a product version

- SubscriptionProductVersionsService
  * post_subscriptions_products_versions     POST /subscriptions/products/versions     Create a product version

- SubscriptionProductVersionsService
  * post_subscriptions_products_versions_id_activate     POST /subscriptions/products/versions/id/activate     Activate a product version

- SubscriptionProductVersionsService
  * post_subscriptions_products_versions_id_retire     POST /subscriptions/products/versions/id/retire     Retire a product version

- SubscriptionProductsService
  * get_subscriptions_products     GET /subscriptions/products     List all products

- SubscriptionProductsService
  * get_subscriptions_products_id     GET /subscriptions/products/id     Retrieve a product

- SubscriptionProductsService
  * get_subscriptions_products_search     GET /subscriptions/products/search     Search products

- SubscriptionProductsService
  * patch_subscriptions_products_id     PATCH /subscriptions/products/id     Update a product

- SubscriptionProductsService
  * post_subscriptions_products     POST /subscriptions/products     Create a product

- SubscriptionProductsService
  * post_subscriptions_products_id_retire     POST /subscriptions/products/id/retire     Retire a product

- SubscriptionSuspensionsService
  * get_subscriptions_suspensions     GET /subscriptions/suspensions     List all suspensions

- SubscriptionSuspensionsService
  * get_subscriptions_suspensions_id     GET /subscriptions/suspensions/id     Retrieve a suspension

- SubscriptionSuspensionsService
  * get_subscriptions_suspensions_search     GET /subscriptions/suspensions/search     Search suspensions

- SubscriptionVersionsService
  * get_subscriptions_versions     GET /subscriptions/versions     List all subscription versions

- SubscriptionVersionsService
  * get_subscriptions_versions_id     GET /subscriptions/versions/id     Retrieve a subscription version

- SubscriptionVersionsService
  * get_subscriptions_versions_search     GET /subscriptions/versions/search     Search subscription versions

- SubscriptionsService
  * get_subscriptions     GET /subscriptions     List all subscriptions

- SubscriptionsService
  * get_subscriptions_id     GET /subscriptions/id     Retrieve a subscription

- SubscriptionsService
  * get_subscriptions_id_invoices     GET /subscriptions/id/invoices     Search subscription invoices

- SubscriptionsService
  * get_subscriptions_search     GET /subscriptions/search     Search subscriptions

- SubscriptionsService
  * patch_subscriptions_id     PATCH /subscriptions/id     Update a subscription

- SubscriptionsService
  * post_subscriptions     POST /subscriptions     Create a subscription

- SubscriptionsService
  * post_subscriptions_id_apply_changes     POST /subscriptions/id/apply-changes     Apply changes to a subscription

- SubscriptionsService
  * post_subscriptions_id_initialize     POST /subscriptions/id/initialize     Initialize a subscription

- SubscriptionsService
  * post_subscriptions_id_initialize_subscriber_present     POST /subscriptions/id/initialize-subscriber-present     Initialize a subscription with the subscriber present

- SubscriptionsService
  * post_subscriptions_id_reactivate     POST /subscriptions/id/reactivate     Reactivate a suspended subscription

- SubscriptionsService
  * post_subscriptions_id_suspend     POST /subscriptions/id/suspend     Suspend a subscription

- SubscriptionsService
  * post_subscriptions_id_terminate     POST /subscriptions/id/terminate     Terminate a subscription

- SubscriptionsService
  * post_subscriptions_id_upgrade_product     POST /subscriptions/id/upgrade-product     Upgrade a subscription's product

- TokenVersionsService
  * get_payment_token_versions     GET /payment/token-versions     List all token versions

- TokenVersionsService
  * get_payment_token_versions_id     GET /payment/token-versions/id     Retrieve a token version

- TokenVersionsService
  * get_payment_token_versions_search     GET /payment/token-versions/search     Search token token versions

- TokensService
  * delete_payment_tokens_id     DELETE /payment/tokens/id     Delete a token

- TokensService
  * get_payment_tokens     GET /payment/tokens     List all tokens

- TokensService
  * get_payment_tokens_id     GET /payment/tokens/id     Retrieve a token

- TokensService
  * get_payment_tokens_id_active_version     GET /payment/tokens/id/active-version     Retrieve the active token version

- TokensService
  * get_payment_tokens_search     GET /payment/tokens/search     Search tokens

- TokensService
  * patch_payment_tokens_id     PATCH /payment/tokens/id     Update a token

- TokensService
  * post_payment_tokens     POST /payment/tokens     Create a token

- TokensService
  * post_payment_tokens_id_create_transaction_for_token_update     POST /payment/tokens/id/create-transaction-for-token-update     Create a transaction for token update

- TransactionClientPlatformsService
  * get_payment_transaction_client_platforms     GET /payment/transaction/client-platforms     List all client platforms

- TransactionClientPlatformsService
  * get_payment_transaction_client_platforms_id     GET /payment/transaction/client-platforms/id     Retrieve the client platform based on id

- TransactionClientPlatformsService
  * get_payment_transaction_client_platforms_search     GET /payment/transaction/client-platforms/search     Search client platforms

- TransactionCommentsService
  * delete_payment_transactions_transaction_id_comments_id     DELETE /payment/transactions/transactionId/comments/id     Delete a transaction comment

- TransactionCommentsService
  * get_payment_transactions_transaction_id_comments     GET /payment/transactions/transactionId/comments     List all transaction comments

- TransactionCommentsService
  * get_payment_transactions_transaction_id_comments_id     GET /payment/transactions/transactionId/comments/id     Retrieve a transaction comment

- TransactionCommentsService
  * get_payment_transactions_transaction_id_comments_search     GET /payment/transactions/transactionId/comments/search     Search transaction comments

- TransactionCommentsService
  * patch_payment_transactions_transaction_id_comments_id     PATCH /payment/transactions/transactionId/comments/id     Update a transaction comment

- TransactionCommentsService
  * post_payment_transactions_transaction_id_comments     POST /payment/transactions/transactionId/comments     Create a transaction comment

- TransactionCommentsService
  * post_payment_transactions_transaction_id_comments_id_pin     POST /payment/transactions/transactionId/comments/id/pin     Pin a comment to the top

- TransactionCommentsService
  * post_payment_transactions_transaction_id_comments_id_unpin     POST /payment/transactions/transactionId/comments/id/unpin     Remove the pinned comment from the top

- TransactionCompletionsService
  * get_payment_transactions_completions     GET /payment/transactions/completions     List all transaction completions

- TransactionCompletionsService
  * get_payment_transactions_completions_id     GET /payment/transactions/completions/id     Retrieve a transaction completion

- TransactionCompletionsService
  * get_payment_transactions_completions_search     GET /payment/transactions/completions/search     Search transaction completions

- TransactionInvoiceCommentsService
  * delete_payment_transactions_invoices_invoice_id_comments_id     DELETE /payment/transactions/invoices/invoiceId/comments/id     Delete a transaction comment

- TransactionInvoiceCommentsService
  * get_payment_transactions_invoices_invoice_id_comments     GET /payment/transactions/invoices/invoiceId/comments     List all transaction invoice comments

- TransactionInvoiceCommentsService
  * get_payment_transactions_invoices_invoice_id_comments_id     GET /payment/transactions/invoices/invoiceId/comments/id     Retrieve a transaction invoice comment

- TransactionInvoiceCommentsService
  * get_payment_transactions_invoices_invoice_id_comments_search     GET /payment/transactions/invoices/invoiceId/comments/search     Search transaction invoice comments

- TransactionInvoiceCommentsService
  * patch_payment_transactions_invoices_invoice_id_comments_id     PATCH /payment/transactions/invoices/invoiceId/comments/id     Update a transaction comment

- TransactionInvoiceCommentsService
  * post_payment_transactions_invoices_invoice_id_comments     POST /payment/transactions/invoices/invoiceId/comments     Create a transaction invoice comment

- TransactionInvoiceCommentsService
  * post_payment_transactions_invoices_invoice_id_comments_id_pin     POST /payment/transactions/invoices/invoiceId/comments/id/pin     Pin a comment to the top

- TransactionInvoiceCommentsService
  * post_payment_transactions_invoices_invoice_id_comments_id_unpin     POST /payment/transactions/invoices/invoiceId/comments/id/unpin     Remove the pinned comment from the top

- TransactionInvoicesService
  * get_payment_transactions_invoices     GET /payment/transactions/invoices     List all transaction invoices

- TransactionInvoicesService
  * get_payment_transactions_invoices_id     GET /payment/transactions/invoices/id     Retrieve a transaction invoice

- TransactionInvoicesService
  * get_payment_transactions_invoices_id_check_replacement_possible     GET /payment/transactions/invoices/id/check-replacement-possible     Check if a transaction invoice can be replaced

- TransactionInvoicesService
  * get_payment_transactions_invoices_id_document     GET /payment/transactions/invoices/id/document     Retrieve an invoice document

- TransactionInvoicesService
  * get_payment_transactions_invoices_search     GET /payment/transactions/invoices/search     Search transaction invoices

- TransactionInvoicesService
  * post_payment_transactions_invoices_id_derecognize     POST /payment/transactions/invoices/id/derecognize     Derecognize a transaction invoice

- TransactionInvoicesService
  * post_payment_transactions_invoices_id_mark_paid     POST /payment/transactions/invoices/id/mark-paid     Mark a transaction invoice as paid

- TransactionInvoicesService
  * post_payment_transactions_invoices_id_replace     POST /payment/transactions/invoices/id/replace     Replace a transaction invoice

- TransactionLineItemVersionsService
  * get_payment_transactions_line_item_versions     GET /payment/transactions/line-item-versions     List all transaction line item versions

- TransactionLineItemVersionsService
  * get_payment_transactions_line_item_versions_id     GET /payment/transactions/line-item-versions/id     Retrieve a transaction line item version

- TransactionLineItemVersionsService
  * get_payment_transactions_line_item_versions_search     GET /payment/transactions/line-item-versions/search     Search transaction line item versions

- TransactionLineItemVersionsService
  * post_payment_transactions_line_item_versions     POST /payment/transactions/line-item-versions     Create a transaction line item version

- TransactionVoidsService
  * get_payment_transactions_voids     GET /payment/transactions/voids     List all transaction voids

- TransactionVoidsService
  * get_payment_transactions_voids_id     GET /payment/transactions/voids/id     Retrieve a transaction void

- TransactionVoidsService
  * get_payment_transactions_voids_search     GET /payment/transactions/voids/search     Search transaction voids

- TransactionsService
  * delete_payment_transactions_by_credentials_credentials_one_click_tokens_id     DELETE /payment/transactions/by-credentials/credentials/one-click-tokens/id     Delete a one-click token by credentials

- TransactionsService
  * get_payment_transactions     GET /payment/transactions     List all transactions

- TransactionsService
  * get_payment_transactions_by_credentials_credentials     GET /payment/transactions/by-credentials/credentials     Retrieve a transaction by credentials

- TransactionsService
  * get_payment_transactions_by_credentials_credentials_mobile_sdk_url     GET /payment/transactions/by-credentials/credentials/mobile-sdk-url     Retrieve a Mobile SDK URL by credentials

- TransactionsService
  * get_payment_transactions_by_credentials_credentials_one_click_tokens     GET /payment/transactions/by-credentials/credentials/one-click-tokens     List one-click tokens by credentials

- TransactionsService
  * get_payment_transactions_by_credentials_credentials_payment_method_configurations     GET /payment/transactions/by-credentials/credentials/payment-method-configurations     List available payment method configurations by credentials

- TransactionsService
  * get_payment_transactions_export     GET /payment/transactions/export     Export transactions

- TransactionsService
  * get_payment_transactions_id     GET /payment/transactions/id     Retrieve a transaction

- TransactionsService
  * get_payment_transactions_id_charge_flow_payment_page_url     GET /payment/transactions/id/charge-flow/payment-page-url     Retrieve a charge flow payment page URL

- TransactionsService
  * get_payment_transactions_id_check_token_creation_possible     GET /payment/transactions/id/check-token-creation-possible     Check if token can be created

- TransactionsService
  * get_payment_transactions_id_credentials     GET /payment/transactions/id/credentials     Retrieve transaction credentials

- TransactionsService
  * get_payment_transactions_id_iframe_javascript_url     GET /payment/transactions/id/iframe-javascript-url     Retrieve an iFrame JavaScript URL

- TransactionsService
  * get_payment_transactions_id_invoice_document     GET /payment/transactions/id/invoice-document     Retrieve an invoice document

- TransactionsService
  * get_payment_transactions_id_latest_line_item_version     GET /payment/transactions/id/latest-line-item-version     Retrieve the latest line item version

- TransactionsService
  * get_payment_transactions_id_lightbox_javascript_url     GET /payment/transactions/id/lightbox-javascript-url     Retrieve a Lightbox JavaScript URL

- TransactionsService
  * get_payment_transactions_id_packing_slip_document     GET /payment/transactions/id/packing-slip-document     Retrieve a packing slip document

- TransactionsService
  * get_payment_transactions_id_payment_method_configurations     GET /payment/transactions/id/payment-method-configurations     List available payment method configurations

- TransactionsService
  * get_payment_transactions_id_payment_page_url     GET /payment/transactions/id/payment-page-url     Retrieve a payment page URL

- TransactionsService
  * get_payment_transactions_id_terminal_receipts     GET /payment/transactions/id/terminal-receipts     List terminal receipts

- TransactionsService
  * get_payment_transactions_search     GET /payment/transactions/search     Search transactions

- TransactionsService
  * patch_payment_transactions_id     PATCH /payment/transactions/id     Update a transaction

- TransactionsService
  * post_payment_transactions     POST /payment/transactions     Create a transaction

- TransactionsService
  * post_payment_transactions_by_credentials_credentials_one_click_tokens_id_process     POST /payment/transactions/by-credentials/credentials/one-click-tokens/id/process     Process via one-click token by credentials

- TransactionsService
  * post_payment_transactions_id_charge_flow_apply     POST /payment/transactions/id/charge-flow/apply     Process a transaction via charge flow

- TransactionsService
  * post_payment_transactions_id_charge_flow_cancel     POST /payment/transactions/id/charge-flow/cancel     Cancel a charge flow

- TransactionsService
  * post_payment_transactions_id_charge_flow_update_recipient     POST /payment/transactions/id/charge-flow/update-recipient     Update a charge flow recipient

- TransactionsService
  * post_payment_transactions_id_complete_offline     POST /payment/transactions/id/complete-offline     Complete a transaction offline

- TransactionsService
  * post_payment_transactions_id_complete_online     POST /payment/transactions/id/complete-online     Complete a transaction online

- TransactionsService
  * post_payment_transactions_id_complete_partially_offline     POST /payment/transactions/id/complete-partially-offline     Complete a transaction offline partially

- TransactionsService
  * post_payment_transactions_id_complete_partially_online     POST /payment/transactions/id/complete-partially-online     Complete a transaction online partially

- TransactionsService
  * post_payment_transactions_id_confirm     POST /payment/transactions/id/confirm     Confirm a transaction

- TransactionsService
  * post_payment_transactions_id_process_card_details     POST /payment/transactions/id/process-card-details     Process a card transaction

- TransactionsService
  * post_payment_transactions_id_process_card_details_threed     POST /payment/transactions/id/process-card-details-threed     Process a card transaction with 3-D Secure

- TransactionsService
  * post_payment_transactions_id_process_with_token     POST /payment/transactions/id/process-with-token     Process a transaction via token

- TransactionsService
  * post_payment_transactions_id_process_without_interaction     POST /payment/transactions/id/process-without-interaction     Process a transaction without user-interaction

- TransactionsService
  * post_payment_transactions_id_void_offline     POST /payment/transactions/id/void-offline     Void a transaction offline

- TransactionsService
  * post_payment_transactions_id_void_online     POST /payment/transactions/id/void-online     Void a transaction online

- WebAppsService
  * get_web_apps_installed     GET /web-apps/installed     Check whether the web app is installed

- WebAppsService
  * post_web_apps_confirm_code     POST /web-apps/confirm/code     Confirm a web app installation

- WebAppsService
  * post_web_apps_uninstall     POST /web-apps/uninstall     Uninstall a web app

- WebhookEncryptionKeysService
  * get_webhooks_encryption_keys_id     GET /webhooks/encryption-keys/id     Retrieve a webhook encryption key

- WebhookListenersService
  * delete_webhooks_listeners_bulk     DELETE /webhooks/listeners/bulk     Delete multiple webhook listeners

- WebhookListenersService
  * delete_webhooks_listeners_id     DELETE /webhooks/listeners/id     Delete a webhook listener

- WebhookListenersService
  * get_webhooks_listeners     GET /webhooks/listeners     List all webhook listeners

- WebhookListenersService
  * get_webhooks_listeners_id     GET /webhooks/listeners/id     Retrieve a webhook listener

- WebhookListenersService
  * get_webhooks_listeners_search     GET /webhooks/listeners/search     Search webhook listeners

- WebhookListenersService
  * patch_webhooks_listeners_bulk     PATCH /webhooks/listeners/bulk     Update multiple webhook listeners

- WebhookListenersService
  * patch_webhooks_listeners_id     PATCH /webhooks/listeners/id     Update a webhook listener

- WebhookListenersService
  * post_webhooks_listeners     POST /webhooks/listeners     Create a webhook listener

- WebhookListenersService
  * post_webhooks_listeners_bulk     POST /webhooks/listeners/bulk     Create multiple webhook listeners

- WebhookURLsService
  * delete_webhooks_urls_bulk     DELETE /webhooks/urls/bulk     Delete multiple webhook URLs

- WebhookURLsService
  * delete_webhooks_urls_id     DELETE /webhooks/urls/id     Delete a webhook URL

- WebhookURLsService
  * get_webhooks_urls     GET /webhooks/urls     List all webhook URLs

- WebhookURLsService
  * get_webhooks_urls_id     GET /webhooks/urls/id     Retrieve a webhook URL

- WebhookURLsService
  * get_webhooks_urls_search     GET /webhooks/urls/search     Search webhook URLs

- WebhookURLsService
  * patch_webhooks_urls_bulk     PATCH /webhooks/urls/bulk     Update multiple webhook URLs

- WebhookURLsService
  * patch_webhooks_urls_id     PATCH /webhooks/urls/id     Update a webhook URL

- WebhookURLsService
  * post_webhooks_urls     POST /webhooks/urls     Create a webhook URL

- WebhookURLsService
  * post_webhooks_urls_bulk     POST /webhooks/urls/bulk     Create multiple webhook URLs

Documentation for Models

Additional Api models documentation: link

Click here to see full list of models

Models:

* AbstractAccountUpdate * AbstractApplicationUserUpdate * AbstractCustomerActive * AbstractCustomerAddressActive * AbstractCustomerCommentActive * AbstractDebtCollectionCaseUpdate * AbstractDebtCollectorConfigurationUpdate * AbstractHumanUserUpdate * AbstractPaymentConnectorConfigurationUpdate * AbstractPaymentLinkUpdate * AbstractPaymentMethodConfigurationUpdate * AbstractPaymentProcessorConfigurationActive * AbstractPaymentTerminalUpdate * AbstractRefundCommentActive * AbstractRoleUpdate * AbstractSingleSignOnUserUpdate * AbstractSpaceUpdate * AbstractSubscriberUpdate * AbstractSubscriptionAffiliateUpdate * AbstractSubscriptionMetricUpdate * AbstractSubscriptionProductActive * AbstractTokenUpdate * AbstractTransactionCommentActive * AbstractTransactionInvoiceCommentActive * AbstractTransactionPending * AbstractWebhookListenerUpdate * AbstractWebhookUrlUpdate * Account * AccountCreate * AccountListResponse * AccountSearchResponse * AccountState * AccountType * AccountUpdate * Address * AddressCreate * AnalyticsQueryExecutionRequest * AnalyticsQueryExecutionResponse * ApplicationKeyState * ApplicationUser * ApplicationUserCreate * ApplicationUserCreateWithMacKey * ApplicationUserListResponse * ApplicationUserSearchResponse * ApplicationUserUpdate * AuthenticatedCardData * AuthenticatedCardDataCreate * AuthenticatedCardRequest * BankAccount * BankAccountEnvironment * BankAccountListResponse * BankAccountSearchResponse * BankAccountState * BankAccountType * BankTransaction * BankTransactionFlowDirection * BankTransactionListResponse * BankTransactionSearchResponse * BankTransactionSource * BankTransactionState * BankTransactionType * BillingCycleModel * BillingCycleType * BillingDayCustomization * CardAuthenticationResponse * CardAuthenticationVersion * CardCryptogram * CardCryptogramCreate * CardholderAuthentication * CardholderAuthenticationCreate * Charge * ChargeAttempt * ChargeAttemptEnvironment * ChargeAttemptListResponse * ChargeAttemptSearchResponse * ChargeAttemptState * ChargeBankTransaction * ChargeBankTransactionListResponse * ChargeBankTransactionSearchResponse * ChargeFlow * ChargeFlowLevel * ChargeFlowLevelConfiguration * ChargeFlowLevelConfigurationType * ChargeFlowLevelListResponse * ChargeFlowLevelPaymentLink * ChargeFlowLevelPaymentLinkListResponse * ChargeFlowLevelPaymentLinkSearchResponse * ChargeFlowLevelSearchResponse * ChargeFlowLevelState * ChargeFlowListResponse * ChargeFlowSearchResponse * ChargeState * ChargeType * ClientPlatformInformationListResponse * ClientPlatformInformationSearchResponse * CompletionLineItem * CompletionLineItemCreate * CompletionListResponse * CompletionSearchResponse * Condition * ConditionType * ConditionTypeListResponse * ConditionTypeSearchResponse * ConnectorInvocation * ConnectorInvocationStage * CountryListResponse * CountrySearchResponse * CreationEntityState * CurrencyBankAccount * CurrencyBankAccountListResponse * CurrencyBankAccountSearchResponse * CurrencyListResponse * CurrencySearchResponse * Customer * CustomerActive * CustomerAddress * CustomerAddressActive * CustomerAddressCreate * CustomerAddressListResponse * CustomerAddressSearchResponse * CustomerAddressType * CustomerComment * CustomerCommentActive * CustomerCommentCreate * CustomerCommentListResponse * CustomerCommentSearchResponse * CustomerCreate * CustomerEmailAddressListResponse * CustomerListResponse * CustomerPostalAddress * CustomerPostalAddressCreate * CustomerSearchResponse * CustomersPresence * DataCollectionType * DebtCollectionCase * DebtCollectionCaseCreate * DebtCollectionCaseDocument * DebtCollectionCaseDocumentListResponse * DebtCollectionCaseListResponse * DebtCollectionCaseSearchResponse * DebtCollectionCaseSource * DebtCollectionCaseState * DebtCollectionCaseUpdate * DebtCollectionEnvironment * DebtCollectionReceipt * DebtCollectionReceiptSource * DebtCollector * DebtCollectorCondition * DebtCollectorConditionType * DebtCollectorConfiguration * DebtCollectorConfigurationCreate * DebtCollectorConfigurationListResponse * DebtCollectorConfigurationSearchResponse * DebtCollectorConfigurationUpdate * DebtCollectorListResponse * DebtCollectorSearchResponse * DeliveryIndication * DeliveryIndicationDecisionReason * DeliveryIndicationListResponse * DeliveryIndicationSearchResponse * DeliveryIndicationState * DisplayableDayOfWeek * DisplayableMonth * DocumentTemplate * DocumentTemplateListResponse * DocumentTemplateSearchResponse * DocumentTemplateType * DocumentTemplateTypeGroup * DocumentTemplateTypeListResponse * DocumentTemplateTypeSearchResponse * DunningCase * DunningCaseListResponse * DunningCaseSearchResponse * DunningCaseState * DunningCondition * DunningConditionType * DunningFlow * DunningFlowLevel * DunningFlowLevelListResponse * DunningFlowLevelProcessor * DunningFlowLevelSearchResponse * DunningFlowListResponse * DunningFlowSearchResponse * DunningFlowType * Environment * ExpressCheckoutCreateResponse * ExpressCheckoutSession * ExpressCheckoutSessionCreate * ExpressCheckoutSessionState * ExpressCheckoutShippingOption * ExpressCheckoutWalletType * ExternalTransferBankTransaction * ExternalTransferBankTransactionListResponse * ExternalTransferBankTransactionSearchResponse * FacadeUserFriendlyQueryStatusModel * FailureCategory * FailureReason * Feature * FeatureCategory * Gender * HumanUser * HumanUserCreate * HumanUserListResponse * HumanUserSearchResponse * HumanUserUpdate * InternalTransferBankTransaction * InternalTransferBankTransactionListResponse * InternalTransferBankTransactionSearchResponse * InvoiceCommentListResponse * InvoiceCommentSearchResponse * InvoiceListResponse * InvoiceSearchResponse * Label * LabelDescriptor * LabelDescriptorCategory * LabelDescriptorGroup * LabelDescriptorGroupListResponse * LabelDescriptorGroupSearchResponse * LabelDescriptorListResponse * LabelDescriptorSearchResponse * LabelDescriptorType * LanguageListResponse * LanguageSearchResponse * LegalOrganizationForm * LegalOrganizationFormListResponse * LegalOrganizationFormSearchResponse * LineItem * LineItemAttribute * LineItemAttributeCreate * LineItemCreate * LineItemReduction * LineItemReductionCreate * LineItemType * LineItemVersionListResponse * LineItemVersionSearchResponse * LocalizedString * ManualTask * ManualTaskAction * ManualTaskActionStyle * ManualTaskListResponse * ManualTaskSearchResponse * ManualTaskState * ManualTaskType * MetricListResponse * MetricSearchResponse * MetricUsage * MetricUsageListResponse * MetricUsageReportListResponse * MetricUsageReportSearchResponse * OneClickPaymentMode * PanType * PaymentAdjustment * PaymentAdjustmentType * PaymentAppChargeAttemptTargetState * PaymentAppChargeAttemptUpdate * PaymentAppCompletionConfiguration * PaymentAppCompletionConfigurationCreate * PaymentAppCompletionTargetState * PaymentAppCompletionUpdate * PaymentAppConnector * PaymentAppConnectorDetails * PaymentAppConnectorDetailsCreate * PaymentAppConnectorState * PaymentAppProcessor * PaymentAppProcessorDetails * PaymentAppProcessorDetailsCreate * PaymentAppProcessorState * PaymentAppRefundConfiguration * PaymentAppRefundConfigurationCreate * PaymentAppRefundTargetState * PaymentAppRefundUpdate * PaymentAppVoidTargetState * PaymentAppVoidUpdate * PaymentConnector * PaymentConnectorConfiguration * PaymentConnectorConfigurationCreate * PaymentConnectorConfigurationListResponse * PaymentConnectorConfigurationSearchResponse * PaymentConnectorConfigurationUpdate * PaymentConnectorFeature * PaymentConnectorListResponse * PaymentConnectorSearchResponse * PaymentContract * PaymentContractState * PaymentContractType * PaymentInformationHash * PaymentInformationHashType * PaymentLink * PaymentLinkActive * PaymentLinkAddressHandlingMode * PaymentLinkCreate * PaymentLinkListResponse * PaymentLinkProtectionMode * PaymentLinkSearchResponse * PaymentLinkUpdate * PaymentMethod * PaymentMethodBrand * PaymentMethodBrandListResponse * PaymentMethodBrandSearchResponse * PaymentMethodConfiguration * PaymentMethodConfigurationActive * PaymentMethodConfigurationCreate * PaymentMethodConfigurationListResponse * PaymentMethodConfigurationSearchResponse * PaymentMethodConfigurationUpdate * PaymentMethodListResponse * PaymentMethodSearchResponse * PaymentPrimaryRiskTaker * PaymentProcessor * PaymentProcessorConfiguration * PaymentProcessorConfigurationActive * PaymentProcessorConfigurationCreate * PaymentProcessorConfigurationListResponse * PaymentProcessorConfigurationSearchResponse * PaymentProcessorListResponse * PaymentProcessorSearchResponse * PaymentTerminal * PaymentTerminalAddress * PaymentTerminalConfiguration * PaymentTerminalConfigurationState * PaymentTerminalConfigurationVersion * PaymentTerminalConfigurationVersionState * PaymentTerminalCreate * PaymentTerminalLocation * PaymentTerminalLocationState * PaymentTerminalLocationVersion * PaymentTerminalLocationVersionState * PaymentTerminalPreparing * PaymentTerminalReceiptType * PaymentTerminalState * PaymentTerminalTransactionSummaryReference * PaymentTerminalType * PaymentTerminalUpdate * Permission * PermissionListResponse * PermissionSearchResponse * PersistableCurrencyAmount * PersistableCurrencyAmountUpdate * ProductComponentGroupListResponse * ProductComponentGroupSearchResponse * ProductComponentListResponse * ProductComponentSearchResponse * ProductFeeType * ProductListResponse * ProductMeteredFee * ProductMeteredFeeListResponse * ProductMeteredFeeSearchResponse * ProductMeteredFeeTierListResponse * ProductMeteredFeeTierSearchResponse * ProductMeteredFeeUpdate * ProductMeteredTierFee * ProductMeteredTierFeeUpdate * ProductMeteredTierPricing * ProductPeriodFee * ProductPeriodFeeListResponse * ProductPeriodFeeSearchResponse * ProductPeriodFeeUpdate * ProductRetirementListResponse * ProductRetirementSearchResponse * ProductSearchResponse * ProductSetupFee * ProductSetupFeeListResponse * ProductSetupFeeSearchResponse * ProductSetupFeeUpdate * ProductVersionListResponse * ProductVersionRetirementListResponse * ProductVersionRetirementSearchResponse * ProductVersionSearchResponse * RecurringIndicator * Refund * RefundBankTransaction * RefundBankTransactionListResponse * RefundBankTransactionSearchResponse * RefundComment * RefundCommentActive * RefundCommentCreate * RefundCommentListResponse * RefundCommentSearchResponse * RefundCreate * RefundListResponse * RefundRecoveryBankTransaction * RefundRecoveryBankTransactionListResponse * RefundRecoveryBankTransactionSearchResponse * RefundSearchResponse * RefundState * RefundType * RenderedDocument * RenderedTerminalReceipt * RenderedTerminalReceiptListResponse * RestAddressFormat * RestAddressFormatField * RestApiBulkOperationResult * RestApiErrorResponse * RestApplicationUserMacKey * RestApplicationUserMacKeyCreated * RestCountry * RestCountryState * RestCurrency * RestCustomerEmailAddress * RestLanguage * ResultPortionModel * Role * RoleCreate * RoleListResponse * RoleSearchResponse * RoleState * RoleUpdate * SalesChannel * SalesChannelListResponse * SalesChannelSearchResponse * Scope * ScopeSingleSignOnProvider * SingleSignOnUser * SingleSignOnUserCreate * SingleSignOnUserListResponse * SingleSignOnUserSearchResponse * SingleSignOnUserUpdate * SortingOrder * Space * SpaceAddress * SpaceAddressCreate * SpaceCreate * SpaceListResponse * SpaceSearchResponse * SpaceUpdate * SpaceView * StaticValue * StaticValueListResponse * StaticValueSearchResponse * SubmittedAnalyticsQueryExecution * Subscriber * SubscriberActive * SubscriberCreate * SubscriberListResponse * SubscriberSearchResponse * SubscriberUpdate * Subscription * SubscriptionAffiliate * SubscriptionAffiliateCreate * SubscriptionAffiliateDeleted * SubscriptionAffiliateDeleting * SubscriptionAffiliateInactive * SubscriptionAffiliateListResponse * SubscriptionAffiliateSearchResponse * SubscriptionAffiliateUpdate * SubscriptionCharge * SubscriptionChargeCreate * SubscriptionChargeListResponse * SubscriptionChargeProcessingType * SubscriptionChargeSearchResponse * SubscriptionChargeState * SubscriptionChargeType * SubscriptionComponentConfiguration * SubscriptionComponentReferenceConfiguration * SubscriptionCreateRequest * SubscriptionInitializeSubscriberPresentRequest * SubscriptionLedgerEntry * SubscriptionLedgerEntryCreate * SubscriptionLedgerEntryListResponse * SubscriptionLedgerEntrySearchResponse * SubscriptionLedgerEntryState * SubscriptionListResponse * SubscriptionMetric * SubscriptionMetricActive * SubscriptionMetricCreate * SubscriptionMetricType * SubscriptionMetricUpdate * SubscriptionMetricUsageReport * SubscriptionMetricUsageReportCreate * SubscriptionPending * SubscriptionPeriodBill * SubscriptionPeriodBillListResponse * SubscriptionPeriodBillSearchResponse * SubscriptionPeriodBillState * SubscriptionProduct * SubscriptionProductActive * SubscriptionProductComponent * SubscriptionProductComponentGroup * SubscriptionProductComponentGroupUpdate * SubscriptionProductComponentReference * SubscriptionProductComponentReferenceState * SubscriptionProductComponentUpdate * SubscriptionProductCreate * SubscriptionProductRetirement * SubscriptionProductRetirementRequest * SubscriptionProductState * SubscriptionProductVersion * SubscriptionProductVersionPending * SubscriptionProductVersionRetirement * SubscriptionProductVersionRetirementRequest * SubscriptionProductVersionState * SubscriptionSearchResponse * SubscriptionState * SubscriptionSuspension * SubscriptionSuspensionAction * SubscriptionSuspensionReason * SubscriptionSuspensionState * SubscriptionUpdate * SubscriptionUpdateRequest * SubscriptionVersion * SubscriptionVersionListResponse * SubscriptionVersionSearchResponse * SubscriptionVersionState * SuspensionCreationRequest * SuspensionListResponse * SuspensionSearchResponse * Tax * TaxCalculation * TaxClass * TaxCreate * TenantDatabase * TerminalListResponse * TerminalReceiptFormat * TerminalSearchResponse * Token * TokenCreate * TokenListResponse * TokenSearchResponse * TokenUpdate * TokenVersion * TokenVersionListResponse * TokenVersionRetryStrategy * TokenVersionSearchResponse * TokenVersionState * TokenVersionType * TokenizationMode * TokenizedCardData * TokenizedCardDataCreate * TokenizedCardRequest * Transaction * TransactionClientPlatformInformation * TransactionComment * TransactionCommentActive * TransactionCommentCreate * TransactionCommentListResponse * TransactionCommentSearchResponse * TransactionCompletion * TransactionCompletionBehavior * TransactionCompletionDetails * TransactionCompletionMode * TransactionCompletionState * TransactionCreate * TransactionEnvironmentSelectionStrategy * TransactionGroup * TransactionGroupState * TransactionInvoice * TransactionInvoiceComment * TransactionInvoiceCommentActive * TransactionInvoiceCommentCreate * TransactionInvoiceReplacement * TransactionInvoiceState * TransactionLineItemVersion * TransactionLineItemVersionCreate * TransactionLineItemVersionState * TransactionListResponse * TransactionPending * TransactionSearchResponse * TransactionState * TransactionUserInterfaceType * TransactionVoid * TransactionVoidListResponse * TransactionVoidMode * TransactionVoidSearchResponse * TransactionVoidState * TwoFactorAuthenticationType * User * UserAccountRole * UserAccountRoleListResponse * UserSpaceRole * UserSpaceRoleListResponse * UserType * WalletType * WebAppConfirmationResponse * WebhookIdentity * WebhookListener * WebhookListenerCreate * WebhookListenerEntity * WebhookListenerListResponse * WebhookListenerSearchResponse * WebhookListenerUpdate * WebhookURLListResponse * WebhookURLSearchResponse * WebhookUrl * WebhookUrlCreate * WebhookUrlUpdate

Error Codes

When working with webhooks, the WalleeRubySdk::WalleeSdkException may throw error codes to help with debugging.

Error Code Categories

Range	Category	Description
404	Not Found	Indicates that the requested resource could not be found or the endpoint returned an empty response
1000–1999	Client-Side Errors	Errors typically caused by invalid input
2000–2999	Server-Side Errors	Errors typically caused by incorrect data provided by the server

Error Code Reference

Code	Error Name	Description	Category
404	UNKNOWN_WEBHOOK_ENCRYPTION_PUBLIC_KEY	Unknown webhook signature public key	Not Found
1000	WEBHOOK_ENCRYPTION_GENERAL_ERROR	General webhook encryption error	Client-Side
1001	INVALID_WEBHOOK_ENCRYPTION_PUBLIC_KEY	Invalid webhook signature public key	Client-Side
1002	INVALID_WEBHOOK_ENCRYPTION_HEADER_FORMAT	Invalid webhook signature header	Client-Side
1003	UNSUPPORTED_WEBHOOK_ENCRYPTION_ALGORYTHM	Unsupported webhook signature algorithm	Client-Side
1004	UNKNOWN_WEBHOOK_ENCRYPTION_PROVIDER	Unknown webhook encryption provider	Client-Side
1005	WEBHOOK_ENCRYPTION_VERIFIER_INIT_ERROR	Encryption verifier initialization error	Client-Side
1006	WEBHOOK_ENCRYPTION_VERIFIER_CONTENT_UPDATE_ERROR	Error during content update in encryption verifier	Client-Side
1007	WEBHOOK_ENCRYPTION_SIGNATURE_VERIFICATION_FAILED	Encryption signature verification failed	Client-Side
1008	INVALID_WEBHOOK_ENCRYPTION_CONTENT_SIGNATURE	Invalid webhook content signature	Client-Side
2000	MISSING_WEBHOOK_ENCRYPTION_ALGORYTHM	Missing webhook signature algorithm value	Server-Side

Usage Example

begin
  # Webhook SDK operation
rescue WalleeSdkException => e
  case e.code
    when 1001
        # Handle invalid public key
    when 1007
        # Handle signature verification failure
  else
    # Handle other errors
  end
end

Author

• Wallee Ecosystem Team
  
  

Automatically generated by the OpenAPI Generator
Generator version: 7.6.0

License

Please see the license file for more information.