| Install | |
|---|---|
composer require postfinancecheckout/sdk |
|
| Latest Version: | 5.2.0 |
| PHP: | ^8.2 |
The PostFinanceCheckout PHP SDK is used to interact with PostFinanceCheckout's REST API.
PHP 8.2 or later.
| PHP SDK version | PHP version | Supported until |
|---|---|---|
| 5.x | 8.2 or later | Further notice |
| 4.x | 5.6 – 7.3 | Fall 2026 |
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 postfinancecheckout/sdk
Please follow the installation instructions, then run the following example:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
use PostFinanceCheckout\Sdk\Sdk\Service\TransactionsService;
use PostFinanceCheckout\Sdk\Sdk\Configuration;
$applicationUserId = 123441;
$authenticationKey = 'oWVGn42ks+yIbuHt8w09kyQRUEgIuYxqd/F59LO/lF0=';
$configuration = Configuration::getDefaultConfiguration(
userId: $applicationUserId,
authenticationKey: $authenticationKey);
$transactionsService = new TransactionsService($configuration);
$spaceId = 72979;
$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;
}
Additional Api services documentation: link
Web Api client: link
API Services:
deleteAccountsId
DELETE /accounts/{id}
Delete an account
getAccounts
GET /accounts
List all accounts
getAccountsId
GET /accounts/{id}
Retrieve an account
getAccountsSearch
GET /accounts/search
Search accounts
patchAccountsId
PATCH /accounts/{id}
Update an account
postAccounts
POST /accounts
Create an account
postAccountsIdActivate
POST /accounts/{id}/activate
Activate an account
postAccountsIdDeactivate
POST /accounts/{id}/deactivate
Deactivate an account
deleteAnalyticsQueriesQueryExternalIdQueryExternalId
DELETE /analytics/queries/queryExternalId/{queryExternalId}
Cancel a query execution, identifying it by its external id.
deleteAnalyticsQueriesQueryTokenQueryToken
DELETE /analytics/queries/queryToken/{queryToken}
Cancel a query execution, identifying it by its query token.
getAnalyticsQueries
GET /analytics/queries
Get portion of query executions for account
getAnalyticsQueriesQueryExternalIdQueryExternalId
GET /analytics/queries/queryExternalId/{queryExternalId}
Retrieve a query execution information by its external id
getAnalyticsQueriesQueryExternalIdQueryExternalIdResult
GET /analytics/queries/queryExternalId/{queryExternalId}/result
Generate a temporary URL to download the query result. It retrieves the query by its external id
getAnalyticsQueriesQueryTokenQueryToken
GET /analytics/queries/queryToken/{queryToken}
Retrieve a query execution information by its query token
getAnalyticsQueriesQueryTokenQueryTokenResult
GET /analytics/queries/queryToken/{queryToken}/result
Generate a temporary URL to download the query result. It retrieves the query by its query token
postAnalyticsQueriesSubmit
POST /analytics/queries/submit
Submit a query execution
deleteApplicationUsersId
DELETE /application-users/{id}
Delete an application user
deleteApplicationUsersUserIdKeysId
DELETE /application-users/{userId}/keys/{id}
Deactivate an authentication key
getApplicationUsers
GET /application-users
List all application users
getApplicationUsersId
GET /application-users/{id}
Retrieve an application user
getApplicationUsersSearch
GET /application-users/search
Search application users
getApplicationUsersUserIdKeys
GET /application-users/{userId}/keys
List a user's authentication keys
patchApplicationUsersId
PATCH /application-users/{id}
Update an application user
postApplicationUsers
POST /application-users
Create an application user
postApplicationUsersUserIdKeys
POST /application-users/{userId}/keys
Generate a new authentication key
deleteApplicationUsersUserIdAccountRoles
DELETE /application-users/{userId}/account-roles
Unassign a role from an application user for an account
deleteApplicationUsersUserIdSpaceRoles
DELETE /application-users/{userId}/space-roles
Unassign a role from an application user for a space
getApplicationUsersUserIdAccountRoles
GET /application-users/{userId}/account-roles
List all roles of an application user for an account
getApplicationUsersUserIdSpaceRoles
GET /application-users/{userId}/space-roles
List all roles of an application user for a space
postApplicationUsersUserIdAccountRoles
POST /application-users/{userId}/account-roles
Assign a role to an application user for an account
postApplicationUsersUserIdSpaceRoles
POST /application-users/{userId}/space-roles
Assign a role to an application user for a space
getPaymentBankAccounts
GET /payment/bank-accounts
List all bank accounts
getPaymentBankAccountsId
GET /payment/bank-accounts/{id}
Retrieve a bank account
getPaymentBankAccountsSearch
GET /payment/bank-accounts/search
Search bank accounts
getPaymentBankTransactions
GET /payment/bank-transactions
List all bank transactions
getPaymentBankTransactionsId
GET /payment/bank-transactions/{id}
Retrieve a bank transaction
getPaymentBankTransactionsSearch
GET /payment/bank-transactions/search
Search bank transactions
postBogusExpressCheckoutOnApprove
POST /bogus-express-checkout/on-approve
Approve express checkout wallet payment
getPaymentChargeAttempts
GET /payment/charge-attempts
List all charge attempts
getPaymentChargeAttemptsId
GET /payment/charge-attempts/{id}
Retrieve a charge attempt
getPaymentChargeAttemptsSearch
GET /payment/charge-attempts/search
Search charge attempts
getPaymentBankTransactionsCharges
GET /payment/bank-transactions/charges
List all charge bank transactions
getPaymentBankTransactionsChargesId
GET /payment/bank-transactions/charges/{id}
Retrieve a charge bank transaction
getPaymentBankTransactionsChargesSearch
GET /payment/bank-transactions/charges/search
Search charge bank transactions
getPaymentChargeFlowsLevels
GET /payment/charge-flows/levels
List all charge flow levels
getPaymentChargeFlowsLevelsId
GET /payment/charge-flows/levels/{id}
Retrieve a charge flow level
getPaymentChargeFlowsLevelsSearch
GET /payment/charge-flows/levels/search
Search charge flow levels
postPaymentChargeFlowsLevelsIdSendMessage
POST /payment/charge-flows/levels/{id}/send-message
Send a payment link
getPaymentChargeFlows
GET /payment/charge-flows
List all charge flows
getPaymentChargeFlowsId
GET /payment/charge-flows/{id}
Retrieve a charge flow
getPaymentChargeFlowsSearch
GET /payment/charge-flows/search
Search charge flows
getPaymentChargeFlowsLevelsPaymentLinks
GET /payment/charge-flows/levels/payment-links
List all charge flow payment links
getPaymentChargeFlowsLevelsPaymentLinksId
GET /payment/charge-flows/levels/payment-links/{id}
Retrieve a charge flow payment link
getPaymentChargeFlowsLevelsPaymentLinksSearch
GET /payment/charge-flows/levels/payment-links/search
Search charge flow payment links
getPaymentConditionTypes
GET /payment/condition-types
List all condition types.
getPaymentConditionTypesId
GET /payment/condition-types/{id}
Retrieve a condition type.
getPaymentConditionTypesSearch
GET /payment/condition-types/search
Search condition types.
getCountries
GET /countries
List all countries
getCountriesCode
GET /countries/{code}
Retrieve a country
getCountriesCountryCodeStates
GET /countries/{countryCode}/states
List all states for a country
getCountriesSearch
GET /countries/search
Search countries
getCountriesStates
GET /countries/states
List all country states
getCountriesStatesId
GET /countries/states/{id}
Retrieve a country state
getCurrencies
GET /currencies
List all currencies
getCurrenciesCode
GET /currencies/{code}
Retrieve a currency
getCurrenciesSearch
GET /currencies/search
Search currencies
getPaymentCurrencyBankAccounts
GET /payment/currency-bank-accounts
List all currency bank accounts
getPaymentCurrencyBankAccountsId
GET /payment/currency-bank-accounts/{id}
Retrieve a currency bank account
getPaymentCurrencyBankAccountsSearch
GET /payment/currency-bank-accounts/search
Search currency bank accounts
deleteCustomersCustomerIdAddressesId
DELETE /customers/{customerId}/addresses/{id}
Delete a customer address
getCustomersCustomerIdAddresses
GET /customers/{customerId}/addresses
List all customer addresses
getCustomersCustomerIdAddressesId
GET /customers/{customerId}/addresses/{id}
Retrieve a customer address
getCustomersCustomerIdAddressesSearch
GET /customers/{customerId}/addresses/search
Search customer addresses
patchCustomersCustomerIdAddressesId
PATCH /customers/{customerId}/addresses/{id}
Update a customer address
postCustomersCustomerIdAddresses
POST /customers/{customerId}/addresses
Create a customer address
postCustomersCustomerIdAddressesIdDefault
POST /customers/{customerId}/addresses/{id}/default
Set the default address for a customer
deleteCustomersCustomerIdCommentsId
DELETE /customers/{customerId}/comments/{id}
Delete a customer comment
getCustomersCustomerIdComments
GET /customers/{customerId}/comments
List all customer comments
getCustomersCustomerIdCommentsId
GET /customers/{customerId}/comments/{id}
Retrieve a customer comment
getCustomersCustomerIdCommentsSearch
GET /customers/{customerId}/comments/search
Search customer comments
patchCustomersCustomerIdCommentsId
PATCH /customers/{customerId}/comments/{id}
Update a customer comment
postCustomersCustomerIdComments
POST /customers/{customerId}/comments
Create a customer comment
postCustomersCustomerIdCommentsIdPin
POST /customers/{customerId}/comments/{id}/pin
Pin a comment to the top
postCustomersCustomerIdCommentsIdUnpin
POST /customers/{customerId}/comments/{id}/unpin
Remove a pinned comment from the top
deleteCustomersBulk
DELETE /customers/bulk
Delete multiple customers
deleteCustomersId
DELETE /customers/{id}
Delete a customer
getCustomers
GET /customers
List all customers
getCustomersId
GET /customers/{id}
Retrieve a customer
getCustomersIdEmailAddresses
GET /customers/{id}/email-addresses
List a customer's email addresses
getCustomersSearch
GET /customers/search
Search customers
patchCustomersBulk
PATCH /customers/bulk
Update multiple customers
patchCustomersId
PATCH /customers/{id}
Update a customer
postCustomers
POST /customers
Create a customer
postCustomersBulk
POST /customers/bulk
Create multiple customers
postCustomersIdMergeOther
POST /customers/{id}/merge/{other}
Merge two customers
getPaymentDeliveryIndications
GET /payment/delivery-indications
List all delivery indications
getPaymentDeliveryIndicationsId
GET /payment/delivery-indications/{id}
Retrieve a delivery indication
getPaymentDeliveryIndicationsSearch
GET /payment/delivery-indications/search
Search delivery indications
postPaymentDeliveryIndicationsIdMarkNotSuitable
POST /payment/delivery-indications/{id}/mark-not-suitable
Mark a delivery indication as not suitable.
postPaymentDeliveryIndicationsIdMarkSuitable
POST /payment/delivery-indications/{id}/mark-suitable
Mark a delivery indication as suitable.
getDocumentTemplatesTypes
GET /document-templates/types
List all document template types
getDocumentTemplatesTypesId
GET /document-templates/types/{id}
Retrieve a document template type
getDocumentTemplatesTypesSearch
GET /document-templates/types/search
Search document template types
getDocumentTemplates
GET /document-templates
List all document templates
getDocumentTemplatesId
GET /document-templates/{id}
Retrieve a document template
getDocumentTemplatesSearch
GET /document-templates/search
Search document templates
getPaymentDunningCases
GET /payment/dunning-cases
List all dunning cases
getPaymentDunningCasesId
GET /payment/dunning-cases/{id}
Retrieve a dunning case
getPaymentDunningCasesSearch
GET /payment/dunning-cases/search
Search dunning cases
postPaymentDunningCasesIdSuspend
POST /payment/dunning-cases/{id}/suspend
Suspend a dunning case
postPaymentDunningCasesInvoiceInvoiceId
POST /payment/dunning-cases/invoice/{invoiceId}
Create a dunning case for an invoice
getPaymentDunningFlowsLevels
GET /payment/dunning-flows/levels
List all dunning flow levels
getPaymentDunningFlowsLevelsId
GET /payment/dunning-flows/levels/{id}
Retrieve a dunning flow level
getPaymentDunningFlowsLevelsSearch
GET /payment/dunning-flows/levels/search
Search dunning flow levels
getPaymentDunningFlows
GET /payment/dunning-flows
List all dunning flows
getPaymentDunningFlowsId
GET /payment/dunning-flows/{id}
Retrieve a dunning flow
getPaymentDunningFlowsSearch
GET /payment/dunning-flows/search
Search dunning flows
patchExpressCheckoutShippingAddressChange
PATCH /express-checkout/shipping/address-change
Change shipping address
patchExpressCheckoutShippingMethodChange
PATCH /express-checkout/shipping/method-change
Change shipping method
postExpressCheckoutCreateSession
POST /express-checkout/create-session
Create a new Express Checkout Session
getPaymentBankTransactionsExternalTransfers
GET /payment/bank-transactions/external-transfers
List all external transfer bank transactions
getPaymentBankTransactionsExternalTransfersId
GET /payment/bank-transactions/external-transfers/{id}
Retrieve an external transfer bank transaction
getPaymentBankTransactionsExternalTransfersSearch
GET /payment/bank-transactions/external-transfers/search
Search external transfer bank transactions
deleteHumanUsersId
DELETE /human-users/{id}
Delete a human user
getHumanUsers
GET /human-users
List all human users
getHumanUsersExport
GET /human-users/export
Export human users
getHumanUsersId
GET /human-users/{id}
Retrieve a human user
getHumanUsersSearch
GET /human-users/search
Search human users
patchHumanUsersId
PATCH /human-users/{id}
Update a human user
postHumanUsers
POST /human-users
Create a human user
deleteHumanUsersUserIdAccountRoles
DELETE /human-users/{userId}/account-roles
Unassign a role from a human user for an account
deleteHumanUsersUserIdSpaceRoles
DELETE /human-users/{userId}/space-roles
Unassign a role from a human user for a space
getHumanUsersUserIdAccountRoles
GET /human-users/{userId}/account-roles
List all roles of a human user for an account
getHumanUsersUserIdSpaceRoles
GET /human-users/{userId}/space-roles
List all roles of a human user for a space
postHumanUsersUserIdAccountRoles
POST /human-users/{userId}/account-roles
Assign a role to a human user for an account
postHumanUsersUserIdSpaceRoles
POST /human-users/{userId}/space-roles
Assign a role to a human user for a space
getPaymentBankTransactionsInternalTransfers
GET /payment/bank-transactions/internal-transfers
List all internal transfer bank transactions
getPaymentBankTransactionsInternalTransfersId
GET /payment/bank-transactions/internal-transfers/{id}
Retrieve an internal transfer bank transaction
getPaymentBankTransactionsInternalTransfersSearch
GET /payment/bank-transactions/internal-transfers/search
Search internal transfer bank transactions
getLabelDescriptors
GET /label-descriptors
List all label descriptors
getLabelDescriptorsGroups
GET /label-descriptors/groups
List all label descriptor groups
getLabelDescriptorsGroupsId
GET /label-descriptors/groups/{id}
Retrieve a label descriptor group
getLabelDescriptorsGroupsSearch
GET /label-descriptors/groups/search
Search label descriptor groups
getLabelDescriptorsId
GET /label-descriptors/{id}
Retrieve a label descriptor
getLabelDescriptorsSearch
GET /label-descriptors/search
Search label descriptors
getLanguages
GET /languages
List all languages
getLanguagesCode
GET /languages/{code}
Retrieve a language
getLanguagesSearch
GET /languages/search
Search languages
getLegalOrganizationForms
GET /legal-organization-forms
List all legal organization forms
getLegalOrganizationFormsId
GET /legal-organization-forms/{id}
Retrieve a legal organization form
getLegalOrganizationFormsSearch
GET /legal-organization-forms/search
Search legal organization forms
getManualTasks
GET /manual-tasks
List all manual tasks
getManualTasksId
GET /manual-tasks/{id}
Retrieve a manual task
getManualTasksIdNotification
GET /manual-tasks/{id}/notification
Retrieve a manual task's notification message
getManualTasksSearch
GET /manual-tasks/search
Search manual tasks
postManualTasksIdActionActionId
POST /manual-tasks/{id}/action/{actionId}
Process a manual task's action
deletePaymentConnectorConfigurationsId
DELETE /payment/connector-configurations/{id}
Delete a payment connector configuration
getPaymentConnectorConfigurations
GET /payment/connector-configurations
List all payment connector configurations
getPaymentConnectorConfigurationsId
GET /payment/connector-configurations/{id}
Retrieve a payment connector configuration
getPaymentConnectorConfigurationsSearch
GET /payment/connector-configurations/search
Search payment connector configurations
patchPaymentConnectorConfigurationsId
PATCH /payment/connector-configurations/{id}
Update a payment connector configuration
postPaymentConnectorConfigurations
POST /payment/connector-configurations
Create a payment connector configuration
getPaymentConnectors
GET /payment/connectors
List all payment connectors.
getPaymentConnectorsId
GET /payment/connectors/{id}
Retrieve a payment connector.
getPaymentConnectorsSearch
GET /payment/connectors/search
Search payment connectors.
deletePaymentLinksId
DELETE /payment/links/{id}
Delete a payment link
getPaymentLinks
GET /payment/links
List all payment links
getPaymentLinksId
GET /payment/links/{id}
Retrieve a payment link
getPaymentLinksSearch
GET /payment/links/search
Search payment links
patchPaymentLinksId
PATCH /payment/links/{id}
Update a payment link
postPaymentLinks
POST /payment/links
Create a payment link
getPaymentMethodBrands
GET /payment/method-brands
List all payment method brands.
getPaymentMethodBrandsId
GET /payment/method-brands/{id}
Retrieve a payment method brand.
getPaymentMethodBrandsSearch
GET /payment/method-brands/search
Search payment method brands.
deletePaymentMethodConfigurationsId
DELETE /payment/method-configurations/{id}
Delete a payment method configuration
getPaymentMethodConfigurations
GET /payment/method-configurations
List all payment method configurations
getPaymentMethodConfigurationsId
GET /payment/method-configurations/{id}
Retrieve a payment method configuration
getPaymentMethodConfigurationsSearch
GET /payment/method-configurations/search
Search payment method configurations
patchPaymentMethodConfigurationsId
PATCH /payment/method-configurations/{id}
Update a payment method configuration
postPaymentMethodConfigurations
POST /payment/method-configurations
Create a payment method configuration
getPaymentMethods
GET /payment/methods
List all payment methods.
getPaymentMethodsId
GET /payment/methods/{id}
Retrieve a payment method.
getPaymentMethodsSearch
GET /payment/methods/search
Search payment methods.
deletePaymentProcessorConfigurationsId
DELETE /payment/processor-configurations/{id}
Delete a payment processor configuration
getPaymentProcessorConfigurations
GET /payment/processor-configurations
List all payment processor configurations
getPaymentProcessorConfigurationsId
GET /payment/processor-configurations/{id}
Retrieve a payment processor configuration
getPaymentProcessorConfigurationsSearch
GET /payment/processor-configurations/search
Search payment processor configurations
patchPaymentProcessorConfigurationsId
PATCH /payment/processor-configurations/{id}
Update a payment processor configuration
postPaymentProcessorConfigurations
POST /payment/processor-configurations
Create a payment processor configuration
getPaymentProcessors
GET /payment/processors
List all payment processors.
getPaymentProcessorsId
GET /payment/processors/{id}
Retrieve a payment processor.
getPaymentProcessorsSearch
GET /payment/processors/search
Search payment processors.
getPaymentSalesChannels
GET /payment/sales-channels
List all payment sales channels.
getPaymentSalesChannelsId
GET /payment/sales-channels/{id}
Retrieve a payment sales channel.
getPaymentSalesChannelsSearch
GET /payment/sales-channels/search
Search payment sales channels.
getPaymentTerminalsTransactionSummaries
GET /payment/terminals/transaction-summaries
List all summaries
getPaymentTerminalsTransactionSummariesId
GET /payment/terminals/transaction-summaries/{id}
Retrieve a summary
getPaymentTerminalsTransactionSummariesIdReceipt
GET /payment/terminals/transaction-summaries/{id}/receipt
Retrieve a rendered summary receipt
getPaymentTerminalsTransactionSummariesSearch
GET /payment/terminals/transaction-summaries/search
Search summaries
deletePaymentTerminalsId
DELETE /payment/terminals/{id}
Delete a payment terminal
getPaymentTerminals
GET /payment/terminals
List all payment terminals
getPaymentTerminalsId
GET /payment/terminals/{id}
Retrieve a payment terminal
getPaymentTerminalsIdTillConnectionCredentials
GET /payment/terminals/{id}/till-connection-credentials
Retrieve till connection credentials
getPaymentTerminalsSearch
GET /payment/terminals/search
Search payment terminals
patchPaymentTerminalsId
PATCH /payment/terminals/{id}
Update a payment terminal
postPaymentTerminals
POST /payment/terminals
Create a payment terminal
postPaymentTerminalsByIdentifierIdentifierPerformTransaction
POST /payment/terminals/by-identifier/{identifier}/perform-transaction
Perform a payment terminal transaction by identifier
postPaymentTerminalsByIdentifierIdentifierTriggerFinalBalance
POST /payment/terminals/by-identifier/{identifier}/trigger-final-balance
Remotely trigger the final balance by identifier
postPaymentTerminalsIdLink
POST /payment/terminals/{id}/link
Link a device with a payment terminal
postPaymentTerminalsIdPerformTransaction
POST /payment/terminals/{id}/perform-transaction
Perform a payment terminal transaction
postPaymentTerminalsIdTriggerFinalBalance
POST /payment/terminals/{id}/trigger-final-balance
Remotely trigger the final balance
postPaymentTerminalsIdUnlink
POST /payment/terminals/{id}/unlink
Unlink any device from a payment terminal
getPermissions
GET /permissions
List all permissions
getPermissionsId
GET /permissions/{id}
Retrieve a permission
getPermissionsSearch
GET /permissions/search
Search permissions
getPaymentBankTransactionsRefunds
GET /payment/bank-transactions/refunds
List all refund bank transactions
getPaymentBankTransactionsRefundsId
GET /payment/bank-transactions/refunds/{id}
Retrieve a refund bank transaction
getPaymentBankTransactionsRefundsSearch
GET /payment/bank-transactions/refunds/search
Search refund bank transactions
deletePaymentRefundsRefundIdCommentsId
DELETE /payment/refunds/{refundId}/comments/{id}
Delete a refund comment
getPaymentRefundsRefundIdComments
GET /payment/refunds/{refundId}/comments
List all refund comments
getPaymentRefundsRefundIdCommentsId
GET /payment/refunds/{refundId}/comments/{id}
Retrieve a refund comment
getPaymentRefundsRefundIdCommentsSearch
GET /payment/refunds/{refundId}/comments/search
Search refund comments
patchPaymentRefundsRefundIdCommentsId
PATCH /payment/refunds/{refundId}/comments/{id}
Update a refund comment
postPaymentRefundsRefundIdComments
POST /payment/refunds/{refundId}/comments
Create a refund comment
postPaymentRefundsRefundIdCommentsIdPin
POST /payment/refunds/{refundId}/comments/{id}/pin
Pin a comment to the top
postPaymentRefundsRefundIdCommentsIdUnpin
POST /payment/refunds/{refundId}/comments/{id}/unpin
Remove the pinned comment from the top
getPaymentBankTransactionsRefundRecoveries
GET /payment/bank-transactions/refund-recoveries
List all refund recovery bank transactions
getPaymentBankTransactionsRefundRecoveriesId
GET /payment/bank-transactions/refund-recoveries/{id}
Retrieve a refund recovery bank transaction
getPaymentBankTransactionsRefundRecoveriesSearch
GET /payment/bank-transactions/refund-recoveries/search
Search refund recovery bank transactions
getPaymentRefunds
GET /payment/refunds
List all refunds
getPaymentRefundsId
GET /payment/refunds/{id}
Retrieve a refund
getPaymentRefundsIdDocument
GET /payment/refunds/{id}/document
Retrieve a refund document
getPaymentRefundsSearch
GET /payment/refunds/search
Search refunds
postPaymentRefunds
POST /payment/refunds
Create a refund
postPaymentRefundsIdMarkFailed
POST /payment/refunds/{id}/mark-failed
Mark a refund as failed
postPaymentRefundsIdMarkSucceeded
POST /payment/refunds/{id}/mark-succeeded
Mark a refund as successful
deleteRolesId
DELETE /roles/{id}
Delete a role
getRoles
GET /roles
List all roles
getRolesId
GET /roles/{id}
Retrieve a role
getRolesSearch
GET /roles/search
Search roles
patchRolesId
PATCH /roles/{id}
Update a role
postRoles
POST /roles
Create a role
deleteSingleSignOnUsersId
DELETE /single-sign-on-users/{id}
Delete a single sign-on user
getSingleSignOnUsers
GET /single-sign-on-users
List all single sign-on users
getSingleSignOnUsersId
GET /single-sign-on-users/{id}
Retrieve a single sign-on user
getSingleSignOnUsersSearch
GET /single-sign-on-users/search
Search single sign-on users
patchSingleSignOnUsersId
PATCH /single-sign-on-users/{id}
Update a single sign-on user
postSingleSignOnUsers
POST /single-sign-on-users
Create a single sign-on user
deleteSingleSignOnUsersUserIdAccountRoles
DELETE /single-sign-on-users/{userId}/account-roles
Unassign a role from a single sign-on user for an account
deleteSingleSignOnUsersUserIdSpaceRoles
DELETE /single-sign-on-users/{userId}/space-roles
Unassign a role from a single sign-on user for a space
getSingleSignOnUsersUserIdAccountRoles
GET /single-sign-on-users/{userId}/account-roles
List all roles of a single sign-on user for an account
getSingleSignOnUsersUserIdSpaceRoles
GET /single-sign-on-users/{userId}/space-roles
List all roles of a single sign-on user for a space
postSingleSignOnUsersUserIdAccountRoles
POST /single-sign-on-users/{userId}/account-roles
Assign a role to a single sign-on user for an account
postSingleSignOnUsersUserIdSpaceRoles
POST /single-sign-on-users/{userId}/space-roles
Assign a role to a single sign-on user for a space
deleteSpacesId
DELETE /spaces/{id}
Delete a space
getSpaces
GET /spaces
List all spaces
getSpacesId
GET /spaces/{id}
Retrieve a space
getSpacesSearch
GET /spaces/search
Search spaces
patchSpacesId
PATCH /spaces/{id}
Update a space
postSpaces
POST /spaces
Create a space
getStaticValues
GET /static-values
List all static values
getStaticValuesId
GET /static-values/{id}
Retrieve a static value
getStaticValuesSearch
GET /static-values/search
Search static values
deleteSubscriptionsSubscribersId
DELETE /subscriptions/subscribers/{id}
Delete a subscriber
getSubscriptionsSubscribers
GET /subscriptions/subscribers
List all subscribers
getSubscriptionsSubscribersId
GET /subscriptions/subscribers/{id}
Retrieve a subscriber
getSubscriptionsSubscribersSearch
GET /subscriptions/subscribers/search
Search subscribers
patchSubscriptionsSubscribersId
PATCH /subscriptions/subscribers/{id}
Update a subscriber
postSubscriptionsSubscribers
POST /subscriptions/subscribers
Create a subscriber
deleteSubscriptionsAffiliatesId
DELETE /subscriptions/affiliates/{id}
Delete an affiliate
getSubscriptionsAffiliates
GET /subscriptions/affiliates
List all affiliates
getSubscriptionsAffiliatesId
GET /subscriptions/affiliates/{id}
Retrieve an affiliate
getSubscriptionsAffiliatesSearch
GET /subscriptions/affiliates/search
Search affiliates
patchSubscriptionsAffiliatesId
PATCH /subscriptions/affiliates/{id}
Update an affiliate
postSubscriptionsAffiliates
POST /subscriptions/affiliates
Create an affiliate
getSubscriptionsCharges
GET /subscriptions/charges
List all charges
getSubscriptionsChargesId
GET /subscriptions/charges/{id}
Retrieve a charge
getSubscriptionsChargesSearch
GET /subscriptions/charges/search
Search charges
postSubscriptionsCharges
POST /subscriptions/charges
Create a charge
postSubscriptionsChargesIdDiscard
POST /subscriptions/charges/{id}/discard
Discard a charge
getSubscriptionsLedgerEntries
GET /subscriptions/ledger-entries
List all ledger entries
getSubscriptionsLedgerEntriesId
GET /subscriptions/ledger-entries/{id}
Retrieve a ledger entry
getSubscriptionsLedgerEntriesSearch
GET /subscriptions/ledger-entries/search
Search ledger entries
postSubscriptionsLedgerEntries
POST /subscriptions/ledger-entries
Create a ledger entry
getSubscriptionsMetricUsageReports
GET /subscriptions/metric-usage-reports
List all metric usage reports
getSubscriptionsMetricUsageReportsId
GET /subscriptions/metric-usage-reports/{id}
Retrieve a metric usage report
getSubscriptionsMetricUsageReportsSearch
GET /subscriptions/metric-usage-reports/search
Search metric usage reports
postSubscriptionsMetricUsageReports
POST /subscriptions/metric-usage-reports
Create a metric usage report
deleteSubscriptionsMetricsId
DELETE /subscriptions/metrics/{id}
Delete a metric
getSubscriptionsMetrics
GET /subscriptions/metrics
List all metrics
getSubscriptionsMetricsId
GET /subscriptions/metrics/{id}
Retrieve a metric
getSubscriptionsMetricsSearch
GET /subscriptions/metrics/search
Search metrics
patchSubscriptionsMetricsId
PATCH /subscriptions/metrics/{id}
Update a metric
postSubscriptionsMetrics
POST /subscriptions/metrics
Create a metric
getSubscriptionsPeriodBills
GET /subscriptions/period-bills
List all subscription period bills
getSubscriptionsPeriodBillsId
GET /subscriptions/period-bills/{id}
Retrieve a subscription period bill
getSubscriptionsPeriodBillsSearch
GET /subscriptions/period-bills/search
Search subscription period bills
postSubscriptionsPeriodBillsIdClose
POST /subscriptions/period-bills/{id}/close
Close a subscription period bill
deleteSubscriptionsProductsComponentGroupsId
DELETE /subscriptions/products/component-groups/{id}
Delete a component group
getSubscriptionsProductsComponentGroups
GET /subscriptions/products/component-groups
List all component groups
getSubscriptionsProductsComponentGroupsId
GET /subscriptions/products/component-groups/{id}
Retrieve a component group
getSubscriptionsProductsComponentGroupsSearch
GET /subscriptions/products/component-groups/search
Search component groups
patchSubscriptionsProductsComponentGroupsId
PATCH /subscriptions/products/component-groups/{id}
Update a component group
postSubscriptionsProductsComponentGroups
POST /subscriptions/products/component-groups
Create a component group
deleteSubscriptionsProductsComponentsId
DELETE /subscriptions/products/components/{id}
Delete a component
getSubscriptionsProductsComponents
GET /subscriptions/products/components
List all components
getSubscriptionsProductsComponentsId
GET /subscriptions/products/components/{id}
Retrieve a component
getSubscriptionsProductsComponentsSearch
GET /subscriptions/products/components/search
Search components
patchSubscriptionsProductsComponentsId
PATCH /subscriptions/products/components/{id}
Update a component
postSubscriptionsProductsComponents
POST /subscriptions/products/components
Create a component
deleteSubscriptionsProductsMeteredFeesFeeIdTiersId
DELETE /subscriptions/products/metered-fees/{feeId}/tiers/{id}
Delete a metered fee tier
getSubscriptionsProductsMeteredFeesFeeIdTiers
GET /subscriptions/products/metered-fees/{feeId}/tiers
List all metered fee tiers
getSubscriptionsProductsMeteredFeesFeeIdTiersId
GET /subscriptions/products/metered-fees/{feeId}/tiers/{id}
Retrieve a metered fee tier
getSubscriptionsProductsMeteredFeesFeeIdTiersSearch
GET /subscriptions/products/metered-fees/{feeId}/tiers/search
Search metered fee tiers
patchSubscriptionsProductsMeteredFeesFeeIdTiersId
PATCH /subscriptions/products/metered-fees/{feeId}/tiers/{id}
Update a metered fee tier
postSubscriptionsProductsMeteredFeesFeeIdTiers
POST /subscriptions/products/metered-fees/{feeId}/tiers
Create a metered fee tier
deleteSubscriptionsProductsMeteredFeesId
DELETE /subscriptions/products/metered-fees/{id}
Delete a metered fee
getSubscriptionsProductsMeteredFees
GET /subscriptions/products/metered-fees
List all metered fees
getSubscriptionsProductsMeteredFeesId
GET /subscriptions/products/metered-fees/{id}
Retrieve a metered fee
getSubscriptionsProductsMeteredFeesSearch
GET /subscriptions/products/metered-fees/search
Search metered fees
patchSubscriptionsProductsMeteredFeesId
PATCH /subscriptions/products/metered-fees/{id}
Update a metered fee
postSubscriptionsProductsMeteredFees
POST /subscriptions/products/metered-fees
Create a metered fee
deleteSubscriptionsProductsPeriodFeesId
DELETE /subscriptions/products/period-fees/{id}
Delete a period fee
getSubscriptionsProductsPeriodFees
GET /subscriptions/products/period-fees
List all period fees
getSubscriptionsProductsPeriodFeesId
GET /subscriptions/products/period-fees/{id}
Retrieve a period fee
getSubscriptionsProductsPeriodFeesSearch
GET /subscriptions/products/period-fees/search
Search period fees
patchSubscriptionsProductsPeriodFeesId
PATCH /subscriptions/products/period-fees/{id}
Update a period fee
postSubscriptionsProductsPeriodFees
POST /subscriptions/products/period-fees
Create a period fee
getSubscriptionsProductsRetirements
GET /subscriptions/products/retirements
List all product retirements
getSubscriptionsProductsRetirementsId
GET /subscriptions/products/retirements/{id}
Retrieve a product retirement
getSubscriptionsProductsRetirementsSearch
GET /subscriptions/products/retirements/search
Search product retirements
deleteSubscriptionsProductsSetupFeesId
DELETE /subscriptions/products/setup-fees/{id}
Delete a setup fee
getSubscriptionsProductsSetupFees
GET /subscriptions/products/setup-fees
List all setup fees
getSubscriptionsProductsSetupFeesId
GET /subscriptions/products/setup-fees/{id}
Retrieve a setup fee
getSubscriptionsProductsSetupFeesSearch
GET /subscriptions/products/setup-fees/search
Search setup fees
patchSubscriptionsProductsSetupFeesId
PATCH /subscriptions/products/setup-fees/{id}
Update a setup fee
postSubscriptionsProductsSetupFees
POST /subscriptions/products/setup-fees
Create a setup fee
getSubscriptionsProductsVersionsRetirements
GET /subscriptions/products/versions/retirements
List all product version retirements
getSubscriptionsProductsVersionsRetirementsId
GET /subscriptions/products/versions/retirements/{id}
Retrieve a product version retirement
getSubscriptionsProductsVersionsRetirementsSearch
GET /subscriptions/products/versions/retirements/search
Search product version retirements
getSubscriptionsProductsVersions
GET /subscriptions/products/versions
List all product versions
getSubscriptionsProductsVersionsId
GET /subscriptions/products/versions/{id}
Retrieve a product version
getSubscriptionsProductsVersionsSearch
GET /subscriptions/products/versions/search
Search product versions
patchSubscriptionsProductsVersionsId
PATCH /subscriptions/products/versions/{id}
Update a product version
postSubscriptionsProductsVersions
POST /subscriptions/products/versions
Create a product version
postSubscriptionsProductsVersionsIdActivate
POST /subscriptions/products/versions/{id}/activate
Activate a product version
postSubscriptionsProductsVersionsIdRetire
POST /subscriptions/products/versions/{id}/retire
Retire a product version
getSubscriptionsProducts
GET /subscriptions/products
List all products
getSubscriptionsProductsId
GET /subscriptions/products/{id}
Retrieve a product
getSubscriptionsProductsSearch
GET /subscriptions/products/search
Search products
patchSubscriptionsProductsId
PATCH /subscriptions/products/{id}
Update a product
postSubscriptionsProducts
POST /subscriptions/products
Create a product
postSubscriptionsProductsIdRetire
POST /subscriptions/products/{id}/retire
Retire a product
getSubscriptionsSuspensions
GET /subscriptions/suspensions
List all suspensions
getSubscriptionsSuspensionsId
GET /subscriptions/suspensions/{id}
Retrieve a suspension
getSubscriptionsSuspensionsSearch
GET /subscriptions/suspensions/search
Search suspensions
getSubscriptionsVersions
GET /subscriptions/versions
List all subscription versions
getSubscriptionsVersionsId
GET /subscriptions/versions/{id}
Retrieve a subscription version
getSubscriptionsVersionsSearch
GET /subscriptions/versions/search
Search subscription versions
getSubscriptions
GET /subscriptions
List all subscriptions
getSubscriptionsId
GET /subscriptions/{id}
Retrieve a subscription
getSubscriptionsIdInvoices
GET /subscriptions/{id}/invoices
Search subscription invoices
getSubscriptionsSearch
GET /subscriptions/search
Search subscriptions
patchSubscriptionsId
PATCH /subscriptions/{id}
Update a subscription
postSubscriptions
POST /subscriptions
Create a subscription
postSubscriptionsIdApplyChanges
POST /subscriptions/{id}/apply-changes
Apply changes to a subscription
postSubscriptionsIdInitialize
POST /subscriptions/{id}/initialize
Initialize a subscription
postSubscriptionsIdInitializeSubscriberPresent
POST /subscriptions/{id}/initialize-subscriber-present
Initialize a subscription with the subscriber present
postSubscriptionsIdReactivate
POST /subscriptions/{id}/reactivate
Reactivate a suspended subscription
postSubscriptionsIdSuspend
POST /subscriptions/{id}/suspend
Suspend a subscription
postSubscriptionsIdTerminate
POST /subscriptions/{id}/terminate
Terminate a subscription
postSubscriptionsIdUpgradeProduct
POST /subscriptions/{id}/upgrade-product
Upgrade a subscription's product
getPaymentTokenVersions
GET /payment/token-versions
List all token versions
getPaymentTokenVersionsId
GET /payment/token-versions/{id}
Retrieve a token version
getPaymentTokenVersionsSearch
GET /payment/token-versions/search
Search token token versions
deletePaymentTokensId
DELETE /payment/tokens/{id}
Delete a token
getPaymentTokens
GET /payment/tokens
List all tokens
getPaymentTokensId
GET /payment/tokens/{id}
Retrieve a token
getPaymentTokensIdActiveVersion
GET /payment/tokens/{id}/active-version
Retrieve the active token version
getPaymentTokensSearch
GET /payment/tokens/search
Search tokens
patchPaymentTokensId
PATCH /payment/tokens/{id}
Update a token
postPaymentTokens
POST /payment/tokens
Create a token
postPaymentTokensIdCreateTransactionForTokenUpdate
POST /payment/tokens/{id}/create-transaction-for-token-update
Create a transaction for token update
getPaymentTransactionClientPlatforms
GET /payment/transaction/client-platforms
List all client platforms
getPaymentTransactionClientPlatformsId
GET /payment/transaction/client-platforms/{id}
Retrieve the client platform based on id
getPaymentTransactionClientPlatformsSearch
GET /payment/transaction/client-platforms/search
Search client platforms
deletePaymentTransactionsTransactionIdCommentsId
DELETE /payment/transactions/{transactionId}/comments/{id}
Delete a transaction comment
getPaymentTransactionsTransactionIdComments
GET /payment/transactions/{transactionId}/comments
List all transaction comments
getPaymentTransactionsTransactionIdCommentsId
GET /payment/transactions/{transactionId}/comments/{id}
Retrieve a transaction comment
getPaymentTransactionsTransactionIdCommentsSearch
GET /payment/transactions/{transactionId}/comments/search
Search transaction comments
patchPaymentTransactionsTransactionIdCommentsId
PATCH /payment/transactions/{transactionId}/comments/{id}
Update a transaction comment
postPaymentTransactionsTransactionIdComments
POST /payment/transactions/{transactionId}/comments
Create a transaction comment
postPaymentTransactionsTransactionIdCommentsIdPin
POST /payment/transactions/{transactionId}/comments/{id}/pin
Pin a comment to the top
postPaymentTransactionsTransactionIdCommentsIdUnpin
POST /payment/transactions/{transactionId}/comments/{id}/unpin
Remove the pinned comment from the top
getPaymentTransactionsCompletions
GET /payment/transactions/completions
List all transaction completions
getPaymentTransactionsCompletionsId
GET /payment/transactions/completions/{id}
Retrieve a transaction completion
getPaymentTransactionsCompletionsSearch
GET /payment/transactions/completions/search
Search transaction completions
deletePaymentTransactionsInvoicesInvoiceIdCommentsId
DELETE /payment/transactions/invoices/{invoiceId}/comments/{id}
Delete a transaction comment
getPaymentTransactionsInvoicesInvoiceIdComments
GET /payment/transactions/invoices/{invoiceId}/comments
List all transaction invoice comments
getPaymentTransactionsInvoicesInvoiceIdCommentsId
GET /payment/transactions/invoices/{invoiceId}/comments/{id}
Retrieve a transaction invoice comment
getPaymentTransactionsInvoicesInvoiceIdCommentsSearch
GET /payment/transactions/invoices/{invoiceId}/comments/search
Search transaction invoice comments
patchPaymentTransactionsInvoicesInvoiceIdCommentsId
PATCH /payment/transactions/invoices/{invoiceId}/comments/{id}
Update a transaction comment
postPaymentTransactionsInvoicesInvoiceIdComments
POST /payment/transactions/invoices/{invoiceId}/comments
Create a transaction invoice comment
postPaymentTransactionsInvoicesInvoiceIdCommentsIdPin
POST /payment/transactions/invoices/{invoiceId}/comments/{id}/pin
Pin a comment to the top
postPaymentTransactionsInvoicesInvoiceIdCommentsIdUnpin
POST /payment/transactions/invoices/{invoiceId}/comments/{id}/unpin
Remove the pinned comment from the top
getPaymentTransactionsInvoices
GET /payment/transactions/invoices
List all transaction invoices
getPaymentTransactionsInvoicesId
GET /payment/transactions/invoices/{id}
Retrieve a transaction invoice
getPaymentTransactionsInvoicesIdCheckReplacementPossible
GET /payment/transactions/invoices/{id}/check-replacement-possible
Check if a transaction invoice can be replaced
getPaymentTransactionsInvoicesIdDocument
GET /payment/transactions/invoices/{id}/document
Retrieve an invoice document
getPaymentTransactionsInvoicesSearch
GET /payment/transactions/invoices/search
Search transaction invoices
postPaymentTransactionsInvoicesIdDerecognize
POST /payment/transactions/invoices/{id}/derecognize
Derecognize a transaction invoice
postPaymentTransactionsInvoicesIdMarkPaid
POST /payment/transactions/invoices/{id}/mark-paid
Mark a transaction invoice as paid
postPaymentTransactionsInvoicesIdReplace
POST /payment/transactions/invoices/{id}/replace
Replace a transaction invoice
getPaymentTransactionsLineItemVersions
GET /payment/transactions/line-item-versions
List all transaction line item versions
getPaymentTransactionsLineItemVersionsId
GET /payment/transactions/line-item-versions/{id}
Retrieve a transaction line item version
getPaymentTransactionsLineItemVersionsSearch
GET /payment/transactions/line-item-versions/search
Search transaction line item versions
postPaymentTransactionsLineItemVersions
POST /payment/transactions/line-item-versions
Create a transaction line item version
getPaymentTransactionsVoids
GET /payment/transactions/voids
List all transaction voids
getPaymentTransactionsVoidsId
GET /payment/transactions/voids/{id}
Retrieve a transaction void
getPaymentTransactionsVoidsSearch
GET /payment/transactions/voids/search
Search transaction voids
deletePaymentTransactionsByCredentialsCredentialsOneClickTokensId
DELETE /payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}
Delete a one-click token by credentials
getPaymentTransactions
GET /payment/transactions
List all transactions
getPaymentTransactionsByCredentialsCredentials
GET /payment/transactions/by-credentials/{credentials}
Retrieve a transaction by credentials
getPaymentTransactionsByCredentialsCredentialsMobileSdkUrl
GET /payment/transactions/by-credentials/{credentials}/mobile-sdk-url
Retrieve a Mobile SDK URL by credentials
getPaymentTransactionsByCredentialsCredentialsOneClickTokens
GET /payment/transactions/by-credentials/{credentials}/one-click-tokens
List one-click tokens by credentials
getPaymentTransactionsByCredentialsCredentialsPaymentMethodConfigurations
GET /payment/transactions/by-credentials/{credentials}/payment-method-configurations
List available payment method configurations by credentials
getPaymentTransactionsExport
GET /payment/transactions/export
Export transactions
getPaymentTransactionsId
GET /payment/transactions/{id}
Retrieve a transaction
getPaymentTransactionsIdChargeFlowPaymentPageUrl
GET /payment/transactions/{id}/charge-flow/payment-page-url
Retrieve a charge flow payment page URL
getPaymentTransactionsIdCheckTokenCreationPossible
GET /payment/transactions/{id}/check-token-creation-possible
Check if token can be created
getPaymentTransactionsIdCredentials
GET /payment/transactions/{id}/credentials
Retrieve transaction credentials
getPaymentTransactionsIdIframeJavascriptUrl
GET /payment/transactions/{id}/iframe-javascript-url
Retrieve an iFrame JavaScript URL
getPaymentTransactionsIdInvoiceDocument
GET /payment/transactions/{id}/invoice-document
Retrieve an invoice document
getPaymentTransactionsIdLatestLineItemVersion
GET /payment/transactions/{id}/latest-line-item-version
Retrieve the latest line item version
getPaymentTransactionsIdLightboxJavascriptUrl
GET /payment/transactions/{id}/lightbox-javascript-url
Retrieve a Lightbox JavaScript URL
getPaymentTransactionsIdPackingSlipDocument
GET /payment/transactions/{id}/packing-slip-document
Retrieve a packing slip document
getPaymentTransactionsIdPaymentMethodConfigurations
GET /payment/transactions/{id}/payment-method-configurations
List available payment method configurations
getPaymentTransactionsIdPaymentPageUrl
GET /payment/transactions/{id}/payment-page-url
Retrieve a payment page URL
getPaymentTransactionsIdTerminalReceipts
GET /payment/transactions/{id}/terminal-receipts
List terminal receipts
getPaymentTransactionsSearch
GET /payment/transactions/search
Search transactions
patchPaymentTransactionsId
PATCH /payment/transactions/{id}
Update a transaction
postPaymentTransactions
POST /payment/transactions
Create a transaction
postPaymentTransactionsByCredentialsCredentialsOneClickTokensIdProcess
POST /payment/transactions/by-credentials/{credentials}/one-click-tokens/{id}/process
Process via one-click token by credentials
postPaymentTransactionsIdChargeFlowApply
POST /payment/transactions/{id}/charge-flow/apply
Process a transaction via charge flow
postPaymentTransactionsIdChargeFlowCancel
POST /payment/transactions/{id}/charge-flow/cancel
Cancel a charge flow
postPaymentTransactionsIdChargeFlowUpdateRecipient
POST /payment/transactions/{id}/charge-flow/update-recipient
Update a charge flow recipient
postPaymentTransactionsIdCompleteOffline
POST /payment/transactions/{id}/complete-offline
Complete a transaction offline
postPaymentTransactionsIdCompleteOnline
POST /payment/transactions/{id}/complete-online
Complete a transaction online
postPaymentTransactionsIdCompletePartiallyOffline
POST /payment/transactions/{id}/complete-partially-offline
Complete a transaction offline partially
postPaymentTransactionsIdCompletePartiallyOnline
POST /payment/transactions/{id}/complete-partially-online
Complete a transaction online partially
postPaymentTransactionsIdConfirm
POST /payment/transactions/{id}/confirm
Confirm a transaction
postPaymentTransactionsIdProcessCardDetails
POST /payment/transactions/{id}/process-card-details
Process a card transaction
postPaymentTransactionsIdProcessCardDetailsThreed
POST /payment/transactions/{id}/process-card-details-threed
Process a card transaction with 3-D Secure
postPaymentTransactionsIdProcessWithToken
POST /payment/transactions/{id}/process-with-token
Process a transaction via token
postPaymentTransactionsIdProcessWithoutInteraction
POST /payment/transactions/{id}/process-without-interaction
Process a transaction without user-interaction
postPaymentTransactionsIdVoidOffline
POST /payment/transactions/{id}/void-offline
Void a transaction offline
postPaymentTransactionsIdVoidOnline
POST /payment/transactions/{id}/void-online
Void a transaction online
getWebAppsInstalled
GET /web-apps/installed
Check whether the web app is installed
postWebAppsConfirmCode
POST /web-apps/confirm/{code}
Confirm a web app installation
postWebAppsUninstall
POST /web-apps/uninstall
Uninstall a web app
getWebhooksEncryptionKeysId
GET /webhooks/encryption-keys/{id}
Retrieve a webhook encryption key
deleteWebhooksListenersBulk
DELETE /webhooks/listeners/bulk
Delete multiple webhook listeners
deleteWebhooksListenersId
DELETE /webhooks/listeners/{id}
Delete a webhook listener
getWebhooksListeners
GET /webhooks/listeners
List all webhook listeners
getWebhooksListenersId
GET /webhooks/listeners/{id}
Retrieve a webhook listener
getWebhooksListenersSearch
GET /webhooks/listeners/search
Search webhook listeners
patchWebhooksListenersBulk
PATCH /webhooks/listeners/bulk
Update multiple webhook listeners
patchWebhooksListenersId
PATCH /webhooks/listeners/{id}
Update a webhook listener
postWebhooksListeners
POST /webhooks/listeners
Create a webhook listener
postWebhooksListenersBulk
POST /webhooks/listeners/bulk
Create multiple webhook listeners
deleteWebhooksUrlsBulk
DELETE /webhooks/urls/bulk
Delete multiple webhook URLs
deleteWebhooksUrlsId
DELETE /webhooks/urls/{id}
Delete a webhook URL
getWebhooksUrls
GET /webhooks/urls
List all webhook URLs
getWebhooksUrlsId
GET /webhooks/urls/{id}
Retrieve a webhook URL
getWebhooksUrlsSearch
GET /webhooks/urls/search
Search webhook URLs
patchWebhooksUrlsBulk
PATCH /webhooks/urls/bulk
Update multiple webhook URLs
patchWebhooksUrlsId
PATCH /webhooks/urls/{id}
Update a webhook URL
postWebhooksUrls
POST /webhooks/urls
Create a webhook URL
postWebhooksUrlsBulk
POST /webhooks/urls/bulk
Create multiple webhook URLs
Additional Api models documentation: link
Models:
When working with webhooks, the PostFinanceCheckoutSdkException may throw error codes to help with debugging.
| Exception | Description |
|---|---|
| ApiExceptionErrorCodes | Lists the possible HTTP error codes an ApiException can generate |
| SdkExceptionErrorCodes | Lists the possible error codes a PostFinanceCheckoutSdkException can generate |
try {
// Operation which can throw ApiException
} catch (ApiException $ex) {
if (ApiExceptionErrorCodes::CONFLICT->matches($ex)) {
// Retry
} else {
// Other handling
}
}
This SDK is generated automatically. The following steps describe how to build the SDK locally and verify its quality using static analysis, coding standards, and tests.
First, build the PHP SDK from the root of the io.wallee.sdk repository:
./gradlew clean php:generate --machineNameOption=Wallee
After the build completes, the generated PHP SDK will be available at:
io.wallee.sdk/platform/php/build/Wallee/php-sdk
Note: Please use PHP 8.4 when working with the generated SDK.
To run code style checks, compatibility checks, and static analysis, install the required development dependencies:
composer require --dev squizlabs/php_codesniffer:^3.13 --with-all-dependencies
composer require --dev phpcompatibility/php-compatibility
composer require --dev dealerdirect/phpcodesniffer-composer-installer
composer require --dev phpstan/phpstan
Verify that the PHPCompatibility standard is correctly installed:
vendor/bin/phpcs -i
You should see PHPCompatibility listed in the installed standards.
⚠️ Important:
Run the following tools only inside the /lib directory.
Running them from the project root would scan the entire repository (~6000 files), which is not intended.
Navigate to the lib directory:
cd lib
../vendor/bin/phpcs -ps . \
--standard=PHPCompatibility \
--runtime-set testVersion 8.2 \
-d memory_limit=512M
This ensures the SDK is compatible with the targeted PHP version.
../vendor/bin/phpstan analyse . --memory-limit=1G
Run the full test suite:
vendor/bin/phpunit --testdox
Run a single test file if needed:
vendor/bin/phpunit --testdox test/QueryingTest.php
Automatically generated by the OpenAPI Generator
Generator version: 7.13.0
Please see the license file for more information.