README

API version: 2.0

The WeArePlanet PHP SDK is used to interact with WeArePlanet's REST API.

Requirements

PHP 8.1 or later.

Installation

Composer

The preferred method is via composer. Follow the installation instructions if you do not already have composer installed.

Once composer is installed, execute the following command in your project root to install this library:

composer require weareplanet/sdk

Getting Started

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use WeArePlanet\Sdk\Sdk\Service\TransactionsService;
use WeArePlanet\Sdk\Sdk\Configuration;

$applicationUserId = 123796;
$authenticationKey = 'Px40LRth2QmpyiyDH/G6Zh64oDbsKVJ70AqK2fhokSg=';

$configuration = Configuration::getDefaultConfiguration( 
    userId: $applicationUserId,
    authenticationKey: $authenticationKey);

$transactionsService = new TransactionsService($configuration);

$spaceId = 38055;
$transactionId = 367155626;
$expandSet = [ 'group' ];

try {
    $transaction = $transactionsService->getPaymentTransactionsId($transactionId, $spaceId, $expandSet);
    print_r($transaction);
} catch (Exception $e) {
    echo 'Exception when calling api: ', $e->getMessage(), PHP_EOL;
}

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://paymentshub.weareplanet.com/
(click on method name to see web doc)

API Services:

AccountsService
* deleteAccountsId DELETE /accounts/{id} Delete an account
AccountsService
* getAccounts GET /accounts List all accounts
AccountsService
* getAccountsId GET /accounts/{id} Retrieve an account
AccountsService
* getAccountsSearch GET /accounts/search Search accounts
AccountsService
* patchAccountsId PATCH /accounts/{id} Update an account
AccountsService
* postAccounts POST /accounts Create an account
AccountsService
* postAccountsIdActivate POST /accounts/{id}/activate Activate an account
AccountsService
* postAccountsIdDeactivate POST /accounts/{id}/deactivate Deactivate an account
ApplicationUsersService
* deleteApplicationUsersId DELETE /application-users/{id} Delete an application user
ApplicationUsersService
* deleteApplicationUsersUserIdKeysId DELETE /application-users/{userId}/keys/{id} Deactivate an authentication key
ApplicationUsersService
* getApplicationUsers GET /application-users List all application users
ApplicationUsersService
* getApplicationUsersId GET /application-users/{id} Retrieve an application user
ApplicationUsersService
* getApplicationUsersSearch GET /application-users/search Search application users
ApplicationUsersService
* getApplicationUsersUserIdKeys GET /application-users/{userId}/keys List a user's authentication keys
ApplicationUsersService
* patchApplicationUsersId PATCH /application-users/{id} Update an application user
ApplicationUsersService
* postApplicationUsers POST /application-users Create an application user
ApplicationUsersService
* postApplicationUsersUserIdKeys POST /application-users/{userId}/keys Generate a new authentication key
ApplicationUsersRolesService
* deleteApplicationUsersUserIdAccountRoles DELETE /application-users/{userId}/account-roles Unassign a role from an application user for an account
ApplicationUsersRolesService
* deleteApplicationUsersUserIdSpaceRoles DELETE /application-users/{userId}/space-roles Unassign a role from an application user for a space
ApplicationUsersRolesService
* getApplicationUsersUserIdAccountRoles GET /application-users/{userId}/account-roles List all roles of an application user for an account
ApplicationUsersRolesService
* getApplicationUsersUserIdSpaceRoles GET /application-users/{userId}/space-roles List all roles of an application user for a space
ApplicationUsersRolesService
* postApplicationUsersUserIdAccountRoles POST /application-users/{userId}/account-roles Assign a role to an application user for an account
ApplicationUsersRolesService
* postApplicationUsersUserIdSpaceRoles POST /application-users/{userId}/space-roles Assign a role to an application user for a space
ChargeAttemptsService
* getPaymentChargeAttempts GET /payment/charge-attempts List all charge attempts
ChargeAttemptsService
* getPaymentChargeAttemptsId GET /payment/charge-attempts/{id} Retrieve a charge attempt
ChargeAttemptsService
* getPaymentChargeAttemptsSearch GET /payment/charge-attempts/search Search charge attempts
ChargeFlowLevelsService
* getPaymentChargeFlowsLevels GET /payment/charge-flows/levels List all charge flow levels
ChargeFlowLevelsService
* getPaymentChargeFlowsLevelsId GET /payment/charge-flows/levels/{id} Retrieve a charge flow level
ChargeFlowLevelsService
* getPaymentChargeFlowsLevelsSearch GET /payment/charge-flows/levels/search Search charge flow levels
ChargeFlowLevelsService
* postPaymentChargeFlowsLevelsIdSendMessage POST /payment/charge-flows/levels/{id}/send-message Send a payment link
ChargeFlowsService
* getPaymentChargeFlows GET /payment/charge-flows List all charge flows
ChargeFlowsService
* getPaymentChargeFlowsId GET /payment/charge-flows/{id} Retrieve a charge flow
ChargeFlowsService
* getPaymentChargeFlowsSearch GET /payment/charge-flows/search Search charge flows
ChargeFlowsLevelPaymentLinksService
* getPaymentChargeFlowsLevelsPaymentLinks GET /payment/charge-flows/levels/payment-links List all charge flow payment links
ChargeFlowsLevelPaymentLinksService
* getPaymentChargeFlowsLevelsPaymentLinksId GET /payment/charge-flows/levels/payment-links/{id} Retrieve a charge flow payment link
ChargeFlowsLevelPaymentLinksService
* getPaymentChargeFlowsLevelsPaymentLinksSearch GET /payment/charge-flows/levels/payment-links/search Search charge flow payment links
ConditionTypesService
* getPaymentConditionTypes GET /payment/condition-types List all condition types.
ConditionTypesService
* getPaymentConditionTypesId GET /payment/condition-types/{id} Retrieve a condition type.
ConditionTypesService
* getPaymentConditionTypesSearch GET /payment/condition-types/search Search condition types.
CountriesService
* getCountries GET /countries List all countries
CountriesService
* getCountriesCode GET /countries/{code} Retrieve a country
CountriesService
* getCountriesCountryCodeStates GET /countries/{countryCode}/states List all states for a country
CountriesService
* getCountriesSearch GET /countries/search Search countries
CountriesService
* getCountriesStates GET /countries/states List all country states
CountriesService
* getCountriesStatesId GET /countries/states/{id} Retrieve a country state
CurrenciesService
* getCurrencies GET /currencies List all currencies
CurrenciesService
* getCurrenciesCode GET /currencies/{code} Retrieve a currency
CurrenciesService
* getCurrenciesSearch GET /currencies/search Search currencies
CustomerAddressesService
* deleteCustomersCustomerIdAddressesId DELETE /customers/{customerId}/addresses/{id} Delete a customer address
CustomerAddressesService
* getCustomersCustomerIdAddresses GET /customers/{customerId}/addresses List all customer addresses
CustomerAddressesService
* getCustomersCustomerIdAddressesId GET /customers/{customerId}/addresses/{id} Retrieve a customer address
CustomerAddressesService
* getCustomersCustomerIdAddressesSearch GET /customers/{customerId}/addresses/search Search customer addresses
CustomerAddressesService
* patchCustomersCustomerIdAddressesId PATCH /customers/{customerId}/addresses/{id} Update a customer address
CustomerAddressesService
* postCustomersCustomerIdAddresses POST /customers/{customerId}/addresses Create a customer address
CustomerAddressesService
* postCustomersCustomerIdAddressesIdDefault POST /customers/{customerId}/addresses/{id}/default Set the default address for a customer
CustomerCommentsService
* deleteCustomersCustomerIdCommentsId DELETE /customers/{customerId}/comments/{id} Delete a customer comment
CustomerCommentsService
* getCustomersCustomerIdComments GET /customers/{customerId}/comments List all customer comments
CustomerCommentsService
* getCustomersCustomerIdCommentsId GET /customers/{customerId}/comments/{id} Retrieve a customer comment
CustomerCommentsService
* getCustomersCustomerIdCommentsSearch GET /customers/{customerId}/comments/search Search customer comments
CustomerCommentsService
* patchCustomersCustomerIdCommentsId PATCH /customers/{customerId}/comments/{id} Update a customer comment
CustomerCommentsService
* postCustomersCustomerIdComments POST /customers/{customerId}/comments Create a customer comment
CustomerCommentsService
* postCustomersCustomerIdCommentsIdPin POST /customers/{customerId}/comments/{id}/pin Pin a comment to the top
CustomerCommentsService
* postCustomersCustomerIdCommentsIdUnpin POST /customers/{customerId}/comments/{id}/unpin Remove a pinned comment from the top
CustomersService
* deleteCustomersBulk DELETE /customers/bulk Delete multiple customers
CustomersService
* deleteCustomersId DELETE /customers/{id} Delete a customer
CustomersService
* getCustomers GET /customers List all customers
CustomersService
* getCustomersId GET /customers/{id} Retrieve a customer
CustomersService
* getCustomersIdEmailAddresses GET /customers/{id}/email-addresses List a customer's email addresses
CustomersService
* getCustomersSearch GET /customers/search Search customers
CustomersService
* patchCustomersBulk PATCH /customers/bulk Update multiple customers
CustomersService
* patchCustomersId PATCH /customers/{id} Update a customer
CustomersService
* postCustomers POST /customers Create a customer
CustomersService
* postCustomersBulk POST /customers/bulk Create multiple customers
CustomersService
* postCustomersIdMergeOther POST /customers/{id}/merge/{other} Merge two customers
DeliveryIndicationsService
* getPaymentDeliveryIndications GET /payment/delivery-indications List all delivery indications
DeliveryIndicationsService
* getPaymentDeliveryIndicationsId GET /payment/delivery-indications/{id} Retrieve a delivery indication
DeliveryIndicationsService
* getPaymentDeliveryIndicationsSearch GET /payment/delivery-indications/search Search delivery indications
DeliveryIndicationsService
* postPaymentDeliveryIndicationsIdMarkNotSuitable POST /payment/delivery-indications/{id}/mark-not-suitable Mark a delivery indication as not suitable.
DeliveryIndicationsService
* postPaymentDeliveryIndicationsIdMarkSuitable POST /payment/delivery-indications/{id}/mark-suitable Mark a delivery indication as suitable.
DocumentTemplateTypesService
* getDocumentTemplatesTypes GET /document-templates/types List all document template types
DocumentTemplateTypesService
* getDocumentTemplatesTypesId GET /document-templates/types/{id} Retrieve a document template type
DocumentTemplateTypesService
* getDocumentTemplatesTypesSearch GET /document-templates/types/search Search document template types
DocumentTemplatesService
* getDocumentTemplates GET /document-templates List all document templates
DocumentTemplatesService
* getDocumentTemplatesId GET /document-templates/{id} Retrieve a document template
DocumentTemplatesService
* getDocumentTemplatesSearch GET /document-templates/search Search document templates
ExpressCheckoutService
* postExpressCheckoutCreateSession POST /express-checkout/create-session Create a new Express Checkout Session
HumanUsersService
* deleteHumanUsersId DELETE /human-users/{id} Delete a human user
HumanUsersService
* getHumanUsers GET /human-users List all human users
HumanUsersService
* getHumanUsersExport GET /human-users/export Export human users
HumanUsersService
* getHumanUsersId GET /human-users/{id} Retrieve a human user
HumanUsersService
* getHumanUsersSearch GET /human-users/search Search human users
HumanUsersService
* patchHumanUsersId PATCH /human-users/{id} Update a human user
HumanUsersService
* postHumanUsers POST /human-users Create a human user
HumanUsersRolesService
* deleteHumanUsersUserIdAccountRoles DELETE /human-users/{userId}/account-roles Unassign a role from a human user for an account
HumanUsersRolesService
* deleteHumanUsersUserIdSpaceRoles DELETE /human-users/{userId}/space-roles Unassign a role from a human user for a space
HumanUsersRolesService
* getHumanUsersUserIdAccountRoles GET /human-users/{userId}/account-roles List all roles of a human user for an account
HumanUsersRolesService
* getHumanUsersUserIdSpaceRoles GET /human-users/{userId}/space-roles List all roles of a human user for a space
HumanUsersRolesService
* postHumanUsersUserIdAccountRoles POST /human-users/{userId}/account-roles Assign a role to a human user for an account
HumanUsersRolesService
* postHumanUsersUserIdSpaceRoles POST /human-users/{userId}/space-roles Assign a role to a human user for a space
LabelDescriptorsService
* getLabelDescriptors GET /label-descriptors List all label descriptors
LabelDescriptorsService
* getLabelDescriptorsGroups GET /label-descriptors/groups List all label descriptor groups
LabelDescriptorsService
* getLabelDescriptorsGroupsId GET /label-descriptors/groups/{id} Retrieve a label descriptor group
LabelDescriptorsService
* getLabelDescriptorsGroupsSearch GET /label-descriptors/groups/search Search label descriptor groups
LabelDescriptorsService
* getLabelDescriptorsId GET /label-descriptors/{id} Retrieve a label descriptor
LabelDescriptorsService
* getLabelDescriptorsSearch GET /label-descriptors/search Search label descriptors
LanguagesService
* getLanguages GET /languages List all languages
LanguagesService
* getLanguagesCode GET /languages/{code} Retrieve a language
LanguagesService
* getLanguagesSearch GET /languages/search Search languages
LegalOrganizationFormsService
* getLegalOrganizationForms GET /legal-organization-forms List all legal organization forms
LegalOrganizationFormsService
* getLegalOrganizationFormsId GET /legal-organization-forms/{id} Retrieve a legal organization form
LegalOrganizationFormsService
* getLegalOrganizationFormsSearch GET /legal-organization-forms/search Search legal organization forms
ManualTasksService
* getManualTasks GET /manual-tasks List all manual tasks
ManualTasksService
* getManualTasksId GET /manual-tasks/{id} Retrieve a manual task
ManualTasksService
* getManualTasksIdNotification GET /manual-tasks/{id}/notification Retrieve a manual task's notification message
ManualTasksService
* getManualTasksSearch GET /manual-tasks/search Search manual tasks
ManualTasksService
* postManualTasksIdActionActionId POST /manual-tasks/{id}/action/{actionId} Process a manual task's action
PaymentConnectorConfigurationsService
* deletePaymentConnectorConfigurationsId DELETE /payment/connector-configurations/{id} Delete a payment connector configuration
PaymentConnectorConfigurationsService
* getPaymentConnectorConfigurations GET /payment/connector-configurations List all payment connector configurations
PaymentConnectorConfigurationsService
* getPaymentConnectorConfigurationsId GET /payment/connector-configurations/{id} Retrieve a payment connector configuration
PaymentConnectorConfigurationsService
* getPaymentConnectorConfigurationsSearch GET /payment/connector-configurations/search Search payment connector configurations
PaymentConnectorConfigurationsService
* patchPaymentConnectorConfigurationsId PATCH /payment/connector-configurations/{id} Update a payment connector configuration
PaymentConnectorConfigurationsService
* postPaymentConnectorConfigurations POST /payment/connector-configurations Create a payment connector configuration
PaymentConnectorsService
* getPaymentConnectors GET /payment/connectors List all payment connectors.
PaymentConnectorsService
* getPaymentConnectorsId GET /payment/connectors/{id} Retrieve a payment connector.
PaymentConnectorsService
* getPaymentConnectorsSearch GET /payment/connectors/search Search payment connectors.
PaymentMethodBrandsService
* getPaymentMethodBrands GET /payment/method-brands List all payment method brands.
PaymentMethodBrandsService
* getPaymentMethodBrandsId GET /payment/method-brands/{id} Retrieve a payment method brand.
PaymentMethodBrandsService
* getPaymentMethodBrandsSearch GET /payment/method-brands/search Search payment method brands.
PaymentMethodConfigurationsService
* deletePaymentMethodConfigurationsId DELETE /payment/method-configurations/{id} Delete a payment method configuration
PaymentMethodConfigurationsService
* getPaymentMethodConfigurations GET /payment/method-configurations List all payment method configurations
PaymentMethodConfigurationsService
* getPaymentMethodConfigurationsId GET /payment/method-configurations/{id} Retrieve a payment method configuration
PaymentMethodConfigurationsService
* getPaymentMethodConfigurationsSearch GET /payment/method-configurations/search Search payment method configurations
PaymentMethodConfigurationsService
* patchPaymentMethodConfigurationsId PATCH /payment/method-configurations/{id} Update a payment method configuration
PaymentMethodConfigurationsService
* postPaymentMethodConfigurations POST /payment/method-configurations Create a payment method configuration
PaymentMethodsService
* getPaymentMethods GET /payment/methods List all payment methods.
PaymentMethodsService
* getPaymentMethodsId GET /payment/methods/{id} Retrieve a payment method.
PaymentMethodsService
* getPaymentMethodsSearch GET /payment/methods/search Search payment methods.
PaymentProcessorConfigurationsService
* deletePaymentProcessorConfigurationsId DELETE /payment/processor-configurations/{id} Delete a payment processor configuration
PaymentProcessorConfigurationsService
* getPaymentProcessorConfigurations GET /payment/processor-configurations List all payment processor configurations
PaymentProcessorConfigurationsService
* getPaymentProcessorConfigurationsId GET /payment/processor-configurations/{id} Retrieve a payment processor configuration
PaymentProcessorConfigurationsService
* getPaymentProcessorConfigurationsSearch GET /payment/processor-configurations/search Search payment processor configurations
PaymentProcessorConfigurationsService
* patchPaymentProcessorConfigurationsId PATCH /payment/processor-configurations/{id} Update a payment processor configuration
PaymentProcessorConfigurationsService
* postPaymentProcessorConfigurations POST /payment/processor-configurations Create a payment processor configuration
PaymentProcessorsService
* getPaymentProcessors GET /payment/processors List all payment processors.
PaymentProcessorsService
* getPaymentProcessorsId GET /payment/processors/{id} Retrieve a payment processor.
PaymentProcessorsService
* getPaymentProcessorsSearch GET /payment/processors/search Search payment processors.
PaymentSalesChannelsService
* getPaymentSalesChannels GET /payment/sales-channels List all payment sales channels.
PaymentSalesChannelsService
* getPaymentSalesChannelsId GET /payment/sales-channels/{id} Retrieve a payment sales channel.
PaymentSalesChannelsService
* getPaymentSalesChannelsSearch GET /payment/sales-channels/search Search payment sales channels.
PaymentWebAppsService
* deletePaymentWebAppsConnectorsConnectorExternalId DELETE /payment/web-apps/connectors/{connectorExternalId} Delete a connector
PaymentWebAppsService
* deletePaymentWebAppsProcessorsExternalId DELETE /payment/web-apps/processors/{externalId} Delete a processor
PaymentWebAppsService
* patchPaymentWebAppsChargeAttemptsId PATCH /payment/web-apps/charge-attempts/{id} Update a charge attempt
PaymentWebAppsService
* patchPaymentWebAppsCompletionsId PATCH /payment/web-apps/completions/{id} Update a completion
PaymentWebAppsService
* patchPaymentWebAppsConnectorsConnectorExternalId PATCH /payment/web-apps/connectors/{connectorExternalId} Update a connector
PaymentWebAppsService
* patchPaymentWebAppsProcessorsExternalId PATCH /payment/web-apps/processors/{externalId} Update a processor
PaymentWebAppsService
* patchPaymentWebAppsRefundsId PATCH /payment/web-apps/refunds/{id} Update a refund
PaymentWebAppsService
* patchPaymentWebAppsVoidsId PATCH /payment/web-apps/voids/{id} Update a void
PaymentWebAppsService
* postPaymentWebAppsProcessors POST /payment/web-apps/processors Create a processor
PaymentWebAppsService
* postPaymentWebAppsProcessorsExternalIdActivateForProduction POST /payment/web-apps/processors/{externalId}/activate-for-production Activate a processor for production
PaymentWebAppsService
* postPaymentWebAppsProcessorsExternalIdConnectors POST /payment/web-apps/processors/{externalId}/connectors Create a connector
PermissionsService
* getPermissions GET /permissions List all permissions
PermissionsService
* getPermissionsId GET /permissions/{id} Retrieve a permission
PermissionsService
* getPermissionsSearch GET /permissions/search Search permissions
RefundCommentsService
* deletePaymentRefundsRefundIdCommentsId DELETE /payment/refunds/{refundId}/comments/{id} Delete a refund comment
RefundCommentsService
* getPaymentRefundsRefundIdComments GET /payment/refunds/{refundId}/comments List all refund comments
RefundCommentsService
* getPaymentRefundsRefundIdCommentsId GET /payment/refunds/{refundId}/comments/{id} Retrieve a refund comment
RefundCommentsService
* getPaymentRefundsRefundIdCommentsSearch GET /payment/refunds/{refundId}/comments/search Search refund comments
RefundCommentsService
* patchPaymentRefundsRefundIdCommentsId PATCH /payment/refunds/{refundId}/comments/{id} Update a refund comment
RefundCommentsService
* postPaymentRefundsRefundIdComments POST /payment/refunds/{refundId}/comments Create a refund comment
RefundCommentsService
* postPaymentRefundsRefundIdCommentsIdPin POST /payment/refunds/{refundId}/comments/{id}/pin Pin a comment to the top
RefundCommentsService
* postPaymentRefundsRefundIdCommentsIdUnpin POST /payment/refunds/{refundId}/comments/{id}/unpin Remove the pinned comment from the top
RefundsService
* getPaymentRefunds GET /payment/refunds List all refunds
RefundsService
* getPaymentRefundsId GET /payment/refunds/{id} Retrieve a refund
RefundsService
* getPaymentRefundsIdDocument GET /payment/refunds/{id}/document Retrieve a refund document
RefundsService
* getPaymentRefundsSearch GET /payment/refunds/search Search refunds
RefundsService
* postPaymentRefunds POST /payment/refunds Create a refund
RefundsService
* postPaymentRefundsIdMarkFailed POST /payment/refunds/{id}/mark-failed Mark a refund as failed
RefundsService
* postPaymentRefundsIdMarkSucceeded POST /payment/refunds/{id}/mark-succeeded Mark a refund as successful
RolesService
* deleteRolesId DELETE /roles/{id} Delete a role
RolesService
* getRoles GET /roles List all roles
RolesService
* getRolesId GET /roles/{id} Retrieve a role
RolesService
* getRolesSearch GET /roles/search Search roles
RolesService
* patchRolesId PATCH /roles/{id} Update a role
RolesService
* postRoles POST /roles Create a role
SingleSignOnUsersService
* deleteSingleSignOnUsersId DELETE /single-sign-on-users/{id} Delete a single sign-on user
SingleSignOnUsersService
* getSingleSignOnUsers GET /single-sign-on-users List all single sign-on users
SingleSignOnUsersService
* getSingleSignOnUsersId GET /single-sign-on-users/{id} Retrieve a single sign-on user
SingleSignOnUsersService
* getSingleSignOnUsersSearch GET /single-sign-on-users/search Search single sign-on users
SingleSignOnUsersService
* patchSingleSignOnUsersId PATCH /single-sign-on-users/{id} Update a single sign-on user
SingleSignOnUsersService
* postSingleSignOnUsers POST /single-sign-on-users Create a single sign-on user
SingleSignOnUsersRolesService
* deleteSingleSignOnUsersUserIdAccountRoles DELETE /single-sign-on-users/{userId}/account-roles Unassign a role from a single sign-on user for an account
SingleSignOnUsersRolesService
* deleteSingleSignOnUsersUserIdSpaceRoles DELETE /single-sign-on-users/{userId}/space-roles Unassign a role from a single sign-on user for a space
SingleSignOnUsersRolesService
* getSingleSignOnUsersUserIdAccountRoles GET /single-sign-on-users/{userId}/account-roles List all roles of a single sign-on user for an account
SingleSignOnUsersRolesService
* getSingleSignOnUsersUserIdSpaceRoles GET /single-sign-on-users/{userId}/space-roles List all roles of a single sign-on user for a space
SingleSignOnUsersRolesService
* postSingleSignOnUsersUserIdAccountRoles POST /single-sign-on-users/{userId}/account-roles Assign a role to a single sign-on user for an account
SingleSignOnUsersRolesService
* postSingleSignOnUsersUserIdSpaceRoles POST /single-sign-on-users/{userId}/space-roles Assign a role to a single sign-on user for a space
SpacesService
* deleteSpacesId DELETE /spaces/{id} Delete a space
SpacesService
* getSpaces GET /spaces List all spaces
SpacesService
* getSpacesId GET /spaces/{id} Retrieve a space
SpacesService
* getSpacesSearch GET /spaces/search Search spaces
SpacesService
* patchSpacesId PATCH /spaces/{id} Update a space
SpacesService
* postSpaces POST /spaces Create a space
StaticValuesService
* getStaticValues GET /static-values List all static values
StaticValuesService
* getStaticValuesId GET /static-values/{id} Retrieve a static value
StaticValuesService
* getStaticValuesSearch GET /static-values/search Search static values
TokenVersionsService
* getPaymentTokenVersions GET /payment/token-versions List all token versions
TokenVersionsService
* getPaymentTokenVersionsId GET /payment/token-versions/{id} Retrieve a token version
TokenVersionsService
* getPaymentTokenVersionsSearch GET /payment/token-versions/search Search token token versions
TokensService
* deletePaymentTokensId DELETE /payment/tokens/{id} Delete a token
TokensService
* getPaymentTokens GET /payment/tokens List all tokens
TokensService
* getPaymentTokensId GET /payment/tokens/{id} Retrieve a token
TokensService
* getPaymentTokensIdActiveVersion GET /payment/tokens/{id}/active-version Retrieve the active token version
TokensService
* getPaymentTokensSearch GET /payment/tokens/search Search tokens
TokensService
* patchPaymentTokensId PATCH /payment/tokens/{id} Update a token
TokensService
* postPaymentTokens POST /payment/tokens Create a token
TokensService
* postPaymentTokensIdCreateTransactionForTokenUpdate POST /payment/tokens/{id}/create-transaction-for-token-update Create a transaction for token update
TransactionClientPlatformsService
* getPaymentTransactionClientPlatforms GET /payment/transaction/client-platforms List all client platforms
TransactionClientPlatformsService
* getPaymentTransactionClientPlatformsId GET /payment/transaction/client-platforms/{id} Retrieve the client platform based on id
TransactionClientPlatformsService
* getPaymentTransactionClientPlatformsSearch GET /payment/transaction/client-platforms/search Search client platforms
TransactionCommentsService
* deletePaymentTransactionsTransactionIdCommentsId DELETE /payment/transactions/{transactionId}/comments/{id} Delete a transaction comment
TransactionCommentsService
* getPaymentTransactionsTransactionIdComments GET /payment/transactions/{transactionId}/comments List all transaction comments
TransactionCommentsService
* getPaymentTransactionsTransactionIdCommentsId GET /payment/transactions/{transactionId}/comments/{id} Retrieve a transaction comment
TransactionCommentsService
* getPaymentTransactionsTransactionIdCommentsSearch GET /payment/transactions/{transactionId}/comments/search Search transaction comments
TransactionCommentsService
* patchPaymentTransactionsTransactionIdCommentsId PATCH /payment/transactions/{transactionId}/comments/{id} Update a transaction comment
TransactionCommentsService
* postPaymentTransactionsTransactionIdComments POST /payment/transactions/{transactionId}/comments Create a transaction comment
TransactionCommentsService
* postPaymentTransactionsTransactionIdCommentsIdPin POST /payment/transactions/{transactionId}/comments/{id}/pin Pin a comment to the top
TransactionCommentsService
* postPaymentTransactionsTransactionIdCommentsIdUnpin POST /payment/transactions/{transactionId}/comments/{id}/unpin Remove the pinned comment from the top
TransactionCompletionsService
* getPaymentTransactionsCompletions GET /payment/transactions/completions List all transaction completions
TransactionCompletionsService
* getPaymentTransactionsCompletionsId GET /payment/transactions/completions/{id} Retrieve a transaction completion
TransactionCompletionsService
* getPaymentTransactionsCompletionsSearch GET /payment/transactions/completions/search Search transaction completions
TransactionInvoiceCommentsService
* deletePaymentTransactionsInvoicesInvoiceIdCommentsId DELETE /payment/transactions/invoices/{invoiceId}/comments/{id} Delete a transaction comment
TransactionInvoiceCommentsService
* getPaymentTransactionsInvoicesInvoiceIdComments GET /payment/transactions/invoices/{invoiceId}/comments List all transaction invoice comments
TransactionInvoiceCommentsService
* getPaymentTransactionsInvoicesInvoiceIdCommentsId GET /payment/transactions/invoices/{invoiceId}/comments/{id} Retrieve a transaction invoice comment
TransactionInvoiceCommentsService
* getPaymentTransactionsInvoicesInvoiceIdCommentsSearch GET /payment/transactions/invoices/{invoiceId}/comments/search Search transaction invoice comments
TransactionInvoiceCommentsService
* patchPaymentTransactionsInvoicesInvoiceIdCommentsId PATCH /payment/transactions/invoices/{invoiceId}/comments/{id} Update a transaction comment
TransactionInvoiceCommentsService
* postPaymentTransactionsInvoicesInvoiceIdComments POST /payment/transactions/invoices/{invoiceId}/comments Create a transaction invoice comment
TransactionInvoiceCommentsService
* postPaymentTransactionsInvoicesInvoiceIdCommentsIdPin POST /payment/transactions/invoices/{invoiceId}/comments/{id}/pin Pin a comment to the top
TransactionInvoiceCommentsService
* postPaymentTransactionsInvoicesInvoiceIdCommentsIdUnpin POST /payment/transactions/invoices/{invoiceId}/comments/{id}/unpin Remove the pinned comment from the top
TransactionInvoicesService
* getPaymentTransactionsInvoices GET /payment/transactions/invoices List all transaction invoices
TransactionInvoicesService
* getPaymentTransactionsInvoicesId GET /payment/transactions/invoices/{id} Retrieve a transaction invoice
TransactionInvoicesService
* getPaymentTransactionsInvoicesIdCheckReplacementPossible GET /payment/transactions/invoices/{id}/check-replacement-possible Check if a transaction invoice can be replaced
TransactionInvoicesService
* getPaymentTransactionsInvoicesIdDocument GET /payment/transactions/invoices/{id}/document Retrieve an invoice document
TransactionInvoicesService
* getPaymentTransactionsInvoicesSearch GET /payment/transactions/invoices/search Search transaction invoices
TransactionInvoicesService
* postPaymentTransactionsInvoicesIdDerecognize POST /payment/transactions/invoices/{id}/derecognize Derecognize a transaction invoice
TransactionInvoicesService
* postPaymentTransactionsInvoicesIdMarkPaid POST /payment/transactions/invoices/{id}/mark-paid Mark a transaction invoice as paid
TransactionInvoicesService
* postPaymentTransactionsInvoicesIdReplace POST /payment/transactions/invoices/{id}/replace Replace a transaction invoice
TransactionLineItemVersionsService
* getPaymentTransactionsLineItemVersions GET /payment/transactions/line-item-versions List all transaction line item versions
TransactionLineItemVersionsService
* getPaymentTransactionsLineItemVersionsId GET /payment/transactions/line-item-versions/{id} Retrieve a transaction line item version
TransactionLineItemVersionsService
* getPaymentTransactionsLineItemVersionsSearch GET /payment/transactions/line-item-versions/search Search transaction line item versions
TransactionLineItemVersionsService
* postPaymentTransactionsLineItemVersions POST /payment/transactions/line-item-versions Create a transaction line item version
TransactionVoidsService
* getPaymentTransactionsVoids GET /payment/transactions/voids List all transaction voids
TransactionVoidsService
* getPaymentTransactionsVoidsId GET /payment/transactions/voids/{id} Retrieve a transaction void
TransactionVoidsService
* getPaymentTransactionsVoidsSearch GET /payment/transactions/voids/search Search transaction voids
TransactionsService
* deletePaymentTransactionsByCredentialsCredentialsOneClickTokensId DELETE /payment/transactions/by-credentials/{credentials}/one-click-tokens/{id} Delete a one-click token by credentials
TransactionsService
* getPaymentTransactions GET /payment/transactions List all transactions
TransactionsService
* getPaymentTransactionsByCredentialsCredentials GET /payment/transactions/by-credentials/{credentials} Retrieve a transaction by credentials
TransactionsService
* getPaymentTransactionsByCredentialsCredentialsMobileSdkUrl GET /payment/transactions/by-credentials/{credentials}/mobile-sdk-url Retrieve a Mobile SDK URL by credentials
TransactionsService
* getPaymentTransactionsByCredentialsCredentialsOneClickTokens GET /payment/transactions/by-credentials/{credentials}/one-click-tokens List one-click tokens by credentials
TransactionsService
* getPaymentTransactionsByCredentialsCredentialsPaymentMethodConfigurations GET /payment/transactions/by-credentials/{credentials}/payment-method-configurations List available payment method configurations by credentials
TransactionsService
* getPaymentTransactionsExport GET /payment/transactions/export Export transactions
TransactionsService
* getPaymentTransactionsId GET /payment/transactions/{id} Retrieve a transaction
TransactionsService
* getPaymentTransactionsIdChargeFlowPaymentPageUrl GET /payment/transactions/{id}/charge-flow/payment-page-url Retrieve a charge flow payment page URL
TransactionsService
* getPaymentTransactionsIdCheckTokenCreationPossible GET /payment/transactions/{id}/check-token-creation-possible Check if token can be created
TransactionsService
* getPaymentTransactionsIdCredentials GET /payment/transactions/{id}/credentials Retrieve transaction credentials
TransactionsService
* getPaymentTransactionsIdIframeJavascriptUrl GET /payment/transactions/{id}/iframe-javascript-url Retrieve an iFrame JavaScript URL
TransactionsService
* getPaymentTransactionsIdInvoiceDocument GET /payment/transactions/{id}/invoice-document Retrieve an invoice document
TransactionsService
* getPaymentTransactionsIdLatestLineItemVersion GET /payment/transactions/{id}/latest-line-item-version Retrieve the latest line item version
TransactionsService
* getPaymentTransactionsIdLightboxJavascriptUrl GET /payment/transactions/{id}/lightbox-javascript-url Retrieve a Lightbox JavaScript URL
TransactionsService
* getPaymentTransactionsIdPackingSlipDocument GET /payment/transactions/{id}/packing-slip-document Retrieve a packing slip document
TransactionsService
* getPaymentTransactionsIdPaymentMethodConfigurations GET /payment/transactions/{id}/payment-method-configurations List available payment method configurations
TransactionsService
* getPaymentTransactionsIdPaymentPageUrl GET /payment/transactions/{id}/payment-page-url Retrieve a payment page URL
TransactionsService
* getPaymentTransactionsIdTerminalReceipts GET /payment/transactions/{id}/terminal-receipts List terminal receipts
TransactionsService
* getPaymentTransactionsSearch GET /payment/transactions/search Search transactions
TransactionsService
* patchPaymentTransactionsId PATCH /payment/transactions/{id} Update a transaction
TransactionsService
* postPaymentTransactions POST /payment/transactions Create a transaction
TransactionsService
* postPaymentTransactionsByCredentialsCredentialsOneClickTokensIdProcess POST /payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}/process Process via one-click token by credentials
TransactionsService
* postPaymentTransactionsIdChargeFlowApply POST /payment/transactions/{id}/charge-flow/apply Process a transaction via charge flow
TransactionsService
* postPaymentTransactionsIdChargeFlowCancel POST /payment/transactions/{id}/charge-flow/cancel Cancel a charge flow
TransactionsService
* postPaymentTransactionsIdChargeFlowUpdateRecipient POST /payment/transactions/{id}/charge-flow/update-recipient Update a charge flow recipient
TransactionsService
* postPaymentTransactionsIdCompleteOffline POST /payment/transactions/{id}/complete-offline Complete a transaction offline
TransactionsService
* postPaymentTransactionsIdCompleteOnline POST /payment/transactions/{id}/complete-online Complete a transaction online
TransactionsService
* postPaymentTransactionsIdCompletePartiallyOffline POST /payment/transactions/{id}/complete-partially-offline Complete a transaction offline partially
TransactionsService
* postPaymentTransactionsIdCompletePartiallyOnline POST /payment/transactions/{id}/complete-partially-online Complete a transaction online partially
TransactionsService
* postPaymentTransactionsIdConfirm POST /payment/transactions/{id}/confirm Confirm a transaction
TransactionsService
* postPaymentTransactionsIdProcessCardDetails POST /payment/transactions/{id}/process-card-details Process a card transaction
TransactionsService
* postPaymentTransactionsIdProcessCardDetailsThreed POST /payment/transactions/{id}/process-card-details-threed Process a card transaction with 3-D Secure
TransactionsService
* postPaymentTransactionsIdProcessWithToken POST /payment/transactions/{id}/process-with-token Process a transaction via token
TransactionsService
* postPaymentTransactionsIdProcessWithoutInteraction POST /payment/transactions/{id}/process-without-interaction Process a transaction without user-interaction
TransactionsService
* postPaymentTransactionsIdVoidOffline POST /payment/transactions/{id}/void-offline Void a transaction offline
TransactionsService
* postPaymentTransactionsIdVoidOnline POST /payment/transactions/{id}/void-online Void a transaction online
WebAppsService
* getWebAppsInstalled GET /web-apps/installed Check whether the web app is installed
WebAppsService
* postWebAppsConfirmCode POST /web-apps/confirm/{code} Confirm a web app installation
WebAppsService
* postWebAppsUninstall POST /web-apps/uninstall Uninstall a web app
WebhookEncryptionKeysService
* getWebhooksEncryptionKeysId GET /webhooks/encryption-keys/{id} Retrieve a webhook encryption key
WebhookListenersService
* deleteWebhooksListenersBulk DELETE /webhooks/listeners/bulk Delete multiple webhook listeners
WebhookListenersService
* deleteWebhooksListenersId DELETE /webhooks/listeners/{id} Delete a webhook listener
WebhookListenersService
* getWebhooksListeners GET /webhooks/listeners List all webhook listeners
WebhookListenersService
* getWebhooksListenersId GET /webhooks/listeners/{id} Retrieve a webhook listener
WebhookListenersService
* getWebhooksListenersSearch GET /webhooks/listeners/search Search webhook listeners
WebhookListenersService
* patchWebhooksListenersBulk PATCH /webhooks/listeners/bulk Update multiple webhook listeners
WebhookListenersService
* patchWebhooksListenersId PATCH /webhooks/listeners/{id} Update a webhook listener
WebhookListenersService
* postWebhooksListeners POST /webhooks/listeners Create a webhook listener
WebhookListenersService
* postWebhooksListenersBulk POST /webhooks/listeners/bulk Create multiple webhook listeners
WebhookURLsService
* deleteWebhooksUrlsBulk DELETE /webhooks/urls/bulk Delete multiple webhook URLs
WebhookURLsService
* deleteWebhooksUrlsId DELETE /webhooks/urls/{id} Delete a webhook URL
WebhookURLsService
* getWebhooksUrls GET /webhooks/urls List all webhook URLs
WebhookURLsService
* getWebhooksUrlsId GET /webhooks/urls/{id} Retrieve a webhook URL
WebhookURLsService
* getWebhooksUrlsSearch GET /webhooks/urls/search Search webhook URLs
WebhookURLsService
* patchWebhooksUrlsBulk PATCH /webhooks/urls/bulk Update multiple webhook URLs
WebhookURLsService
* patchWebhooksUrlsId PATCH /webhooks/urls/{id} Update a webhook URL
WebhookURLsService
* postWebhooksUrls POST /webhooks/urls Create a webhook URL
WebhookURLsService
* postWebhooksUrlsBulk 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
AbstractHumanUserUpdate
AbstractPaymentConnectorConfigurationUpdate
AbstractPaymentMethodConfigurationUpdate
AbstractPaymentProcessorConfigurationActive
AbstractRefundCommentActive
AbstractRoleUpdate
AbstractSingleSignOnUserUpdate
AbstractSpaceUpdate
AbstractTokenUpdate
AbstractTransactionCommentActive
AbstractTransactionInvoiceCommentActive
AbstractTransactionPending
AbstractWebhookListenerUpdate
AbstractWebhookUrlUpdate
Account
AccountCreate
AccountListResponse
AccountSearchResponse
AccountState
AccountType
AccountUpdate
Address
AddressCreate
ApplicationKeyState
ApplicationUser
ApplicationUserCreate
ApplicationUserCreateWithMacKey
ApplicationUserListResponse
ApplicationUserSearchResponse
ApplicationUserUpdate
AuthenticatedCardData
AuthenticatedCardDataCreate
AuthenticatedCardRequest
CardAuthenticationResponse
CardAuthenticationVersion
CardCryptogram
CardCryptogramCreate
CardholderAuthentication
CardholderAuthenticationCreate
Charge
ChargeAttempt
ChargeAttemptEnvironment
ChargeAttemptListResponse
ChargeAttemptSearchResponse
ChargeAttemptState
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
CurrencyListResponse
CurrencySearchResponse
Customer
CustomerActive
CustomerAddress
CustomerAddressActive
CustomerAddressCreate
CustomerAddressListResponse
CustomerAddressSearchResponse
CustomerAddressType
CustomerComment
CustomerCommentActive
CustomerCommentCreate
CustomerCommentListResponse
CustomerCommentSearchResponse
CustomerCreate
CustomerEmailAddressListResponse
CustomerListResponse
CustomerPostalAddress
CustomerPostalAddressCreate
CustomerSearchResponse
CustomersPresence
DataCollectionType
DeliveryIndication
DeliveryIndicationDecisionReason
DeliveryIndicationListResponse
DeliveryIndicationSearchResponse
DeliveryIndicationState
DocumentTemplate
DocumentTemplateListResponse
DocumentTemplateSearchResponse
DocumentTemplateType
DocumentTemplateTypeGroup
DocumentTemplateTypeListResponse
DocumentTemplateTypeSearchResponse
Environment
ExpressCheckoutCreateResponse
ExpressCheckoutSession
ExpressCheckoutSessionCreate
ExpressCheckoutSessionState
ExpressCheckoutShippingOption
ExpressCheckoutWalletType
FailureCategory
FailureReason
Feature
FeatureCategory
Gender
HumanUser
HumanUserCreate
HumanUserListResponse
HumanUserSearchResponse
HumanUserUpdate
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
OneClickPaymentMode
PanType
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
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
PaymentTerminalLocation
PaymentTerminalLocationState
PaymentTerminalLocationVersion
PaymentTerminalLocationVersionState
PaymentTerminalReceiptType
PaymentTerminalState
PaymentTerminalType
Permission
PermissionListResponse
PermissionSearchResponse
RecurringIndicator
Refund
RefundComment
RefundCommentActive
RefundCommentCreate
RefundCommentListResponse
RefundCommentSearchResponse
RefundCreate
RefundListResponse
RefundSearchResponse
RefundState
RefundType
RenderedDocument
RenderedTerminalReceipt
RenderedTerminalReceiptListResponse
RestAddressFormat
RestAddressFormatField
RestApiBulkOperationResult
RestApiErrorResponse
RestApplicationUserMacKey
RestApplicationUserMacKeyCreated
RestCountry
RestCountryState
RestCurrency
RestCustomerEmailAddress
RestLanguage
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
Tax
TaxCreate
TenantDatabase
TerminalReceiptFormat
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 WeArePlanetSdkException 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

try {
    // Webhook SDK operation
} catch (WeArePlanetSdkException $e) {
    switch ($e->getCode()) {
        case 1001: // INVALID_WEBHOOK_ENCRYPTION_PUBLIC_KEY
            // Handle invalid public key
            break;
        case 1007: // WEBHOOK_ENCRYPTION_SIGNATURE_VERIFICATION_FAILED
            // Handle signature verification failure
            break;
        default:
            // Handle other errors
            break;
    }
}

Author

Wallee Ecosystem Team

Automatically generated by the OpenAPI Generator
Generator version: 7.6.0

License

Please see the license file for more information.

weareplanet / sdk

Maintainers

Details