README

A convenient PHP wrapper around API calls and responses:
- marshals PHP request objects to HTTP requests
- unmarshals HTTP responses to PHP response objects or PHP exceptions
handling of all the details concerning authentication
handling of required metadata

For a general introduction to the API and various checkout flows, see the documentation: - General introduction to the PAYONE Commerce Platform - Overview of the checkout flows - Available payment methods

Requirements
Installation
Usage
Demo App
API Reference
Contributing
Development
License

Requirements

This SDK requires PHP 8.2 or later.

back to top

Installation

This SDK is currently not released on packagist. You can install it from GitHub by specifying a vcs repository within your composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/PAYONE-GmbH/PCP-ServerSDK-php"
    }
  ],
  "require": {
    "payone-gmbh/pcp-serversdk-php": "dev-main"
  }
}

These snippets specify the main branch, which contains the latest release. You can specify a version by inserting a git tag vX.Y.Z instead of main. Make sure to prepend the git branch or tag with dev-. For an in depth explanation take a look at the Composer documentation.

back to top

Usage

General

To use this SDK, you need to construct a CommunicatorConfiguration which encapsulates everything needed to connect to the PAYONE Commerce Platform.

<?php

use PayoneCommercePlatform\Sdk\CommunicatorConfiguration;

/** @var CommunicatorConfiguration */
$config = new CommunicatorConfiguration(
        apiKey: getenv('API_KEY'),
        apiSecret: getenv('API_SECRET'),
        host: CommunicatorConfiguration::getPredefinedHosts()['prod']['url'],
        integrator: 'YOUR COMPANY NAME',
);

As shown above, you can use CommunicatorConfiguration::getPredefinedHosts() for information on the available environments. With the configuration you can create an API client for each reource you want to interact with. For example to create a commerce case you can use the CommerceCaseApiClient.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\CommerceCaseApiClient;

$client = new CommerceCaseApiClient($config);

Each client has typed parameters for the payloads and responses. You can use phpstan to verify the types of the parameters and return values or look for TypeError thrown at runtime. All payloads are availble as PHP classes within the PayoneCommercePlatform\Sdk\Models namespace. The SDK will automatically marshal the PHP objects to JSON and send it to the API. The response will be unmarshalled to a PHP object internally.

To create an empty commerce case you can use the CreateCommerceCaseRequest class:

<?php

use PayoneCommercePlatform\Sdk\Models\CreateCommerceCaseResponse;
use PayoneCommercePlatform\Sdk\Models\CreateCommerceCaseRequest;

/** @var CreateCommerceCaseResponse */
$response = $client->createCommerceCase('YOUR_MERCHANT_ID', new CreateCommerceCaseRequest());

The models are directly map to the API as described in the PAYONE Commerce Platform API Reference. For an in depth example you can take a look at the demo app.

Error Handling

When making a request, any client instance may throw a PayoneCommercePlatform\Sdk\Errors\ApiException. There are two subtypes of this exception:

PayoneCommercePlatform\Sdk\Errors\ApiErrorResponseException: This exception is thrown when the API returns an well-formed error response. These errors are provided as an array of PayoneCommercePlatform\Sdk\Models\APIError instances via the getErrors() method on the exception. They usually contain useful information about what is wrong in your request or the state of the resource.
PayoneCommercePlatform\Sdk\Errors\ApiResponseRetrievalException: This exception is a catch-all exception for any error that cannot be turned into a helpful error response. This includes network errors, malformed responses or other errors that are not directly related to the API.

Client Side

For most payment methods, some information from the client is needed, e.g. payment information given by Apple when a payment via ApplePay suceeds. PAYONE provides client side SDKs which helps you interact the third party payment providers. You can find these SDKs under the Payone GitHub organization. Either way ensure to never store or even send credit card information to your server. The PAYONE Commerce Platform never needs access to the credit card information. The client side is responsible for safely retrieving a credit card token. This token must be used with this SDK.

This SDK makes no assumptions about how networking between the client and your PHP server is handled. If need to serialize a model to JSON or deserialize a client side request from a JSON string to a model you can use the static serializeJson() and deserializeJson() methods on the BaseApiClient class:

<?php

use PayoneCommercePlatform\Sdk\ApiClient\BaseApiClient;
use PayoneCommercePlatform\Sdk\Models\ApplePay\AppelPayPayment;

// to json
// make sure to add some useful data
$applePayPayment = new ApplePayPayment();
$json = BaseApiClient::serializeJson($model);

// ...and back
$applePayPaymentRequest = BaseApiClient::deserializeJson($json, ApplePayPayment::class);

As every API clients inherits from BaseApiClient you can use these methods on every client class directly.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\PaymentInformationApiClient;
use PayoneCommercePlatform\Sdk\Models\AmountOfMoney;

$amountOfMoney = new AmountOfMoney(amount: 3199, currencyCode: 'EUR');
PaymentInformationApiClient::serializeJson($amountOfMoney);
// returns:
//      '{ "amount": 3199, currencyCode: "EUR" }'

Apple Pay

When a client successfully makes a payment via ApplePay, it receives a ApplePayPayment. This structure is accessible as a model as PayoneCommercePlatform\Sdk\Models\ApplePay\ApplePayPayment. The model is a direct representation of the ApplePayPayment. You can use the deserializeJson() method to convert a JSON string from a client an ApplePayPayment object.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\BaseApiClient;

// receive json as a string from the client with your favorite networking library or server framework
/** @var string */
$json = getJsonStringFromRequestSomehow();
$applePayPayment = BaseApiClient::deserializeJson($json, ApplePayPayment::class);

You can use the PayoneCommercePlatform\Sdk\Transformer\ApplePayTransformer to map an ApplePayPayment to a MobilePaymentMethodSpecificInput which can be used for payment executions or order requests. The transformer has a static method transformApplePayPaymentToMobilePaymentMethodSpecificInput() which takes an ApplePayPayment and returns a MobilePaymentMethodSpecificInput. The transformer does not check if the reponse is complete. If anything is missing the field will be set to null.

<?php

use PayoneCommercePlatform\Sdk\Transformer\ApplePayTransformer;

$mobilePaymentMethodSpecificInput = ApplePayTransformer::transformApplePayPaymentToMobilePaymentMethodSpecificInput($applePayPayment);

back to top

HTTP Client Customization

The SDK allows you to customize the underlying Guzzle HTTP client used for API requests. This provides flexibility to configure timeouts, add interceptors, set up proxies, implement custom authentication mechanisms, and more.

Overview

HTTP client customization enables you to:

Configure custom timeouts and connection settings
Set up proxy servers for corporate environments
Add custom headers and authentication
Implement request/response middleware for logging or monitoring
Configure SSL/TLS settings
Add retry logic and error handling

Global HTTP Client Configuration

You can set a global HTTP client that will be used by all API clients by passing it to the CommunicatorConfiguration:

<?php

use GuzzleHttp\Client;
use PayoneCommercePlatform\Sdk\CommunicatorConfiguration;
use PayoneCommercePlatform\Sdk\ApiClient\CommerceCaseApiClient;

// Create a custom Guzzle client with specific configuration
$customHttpClient = new Client([
    'timeout' => 30,
    'connect_timeout' => 10,
    'verify' => true,
    'headers' => [
        'User-Agent' => 'MyApp/1.0'
    ]
]);

// Pass the custom client to the configuration
$config = new CommunicatorConfiguration(
    apiKey: getenv('API_KEY'),
    apiSecret: getenv('API_SECRET'),
    host: CommunicatorConfiguration::getPredefinedHosts()['prod']['url'],
    integrator: 'YOUR COMPANY NAME',
    httpClient: $customHttpClient
);

// All API clients created with this configuration will use the custom HTTP client
$commerceCaseClient = new CommerceCaseApiClient($config);

Client-Specific HTTP Client Configuration

You can also set a custom HTTP client for individual API clients, which will override the global configuration:

<?php

use GuzzleHttp\Client;
use PayoneCommercePlatform\Sdk\ApiClient\CommerceCaseApiClient;

// Create a client-specific HTTP client
$clientSpecificHttpClient = new Client([
    'timeout' => 60,  // Different timeout for this specific client
    'proxy' => 'http://proxy.example.com:8080'
]);

// Pass the client-specific HTTP client to the API client constructor
$commerceCaseClient = new CommerceCaseApiClient($config, $clientSpecificHttpClient);

// Or set it after construction
$commerceCaseClient->setHttpClient($clientSpecificHttpClient);

Advanced Configuration Examples

HTTP Client with Middleware

<?php

use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;

// Create a handler stack and add middleware
$stack = HandlerStack::create();

// Add logging middleware
$stack->push(Middleware::mapRequest(function ($request) {
    error_log("Making request to: " . $request->getUri());
    return $request;
}));

// Add retry middleware for failed requests
$stack->push(Middleware::retry(function ($retries, $request, $response, $exception) {
    return $retries < 3 && ($exception || ($response && $response->getStatusCode() >= 500));
}));

// Create HTTP client with the custom handler stack
$httpClientWithMiddleware = new Client([
    'handler' => $stack,
    'timeout' => 30,
    'headers' => [
        'X-SDK-Version' => '1.3.0'
    ]
]);

$config = new CommunicatorConfiguration(
    apiKey: getenv('API_KEY'),
    apiSecret: getenv('API_SECRET'),
    httpClient: $httpClientWithMiddleware
);

Proxy Configuration

<?php

use GuzzleHttp\Client;

// Configure HTTP client with proxy settings
$proxyHttpClient = new Client([
    'proxy' => [
        'http'  => 'http://proxy.example.com:8080',
        'https' => 'https://proxy.example.com:8080',
    ],
    'timeout' => 30,
    'verify' => '/path/to/ca-bundle.crt'  // Custom CA bundle
]);

$config = new CommunicatorConfiguration(
    apiKey: getenv('API_KEY'),
    apiSecret: getenv('API_SECRET'),
    httpClient: $proxyHttpClient
);

Priority Logic

The SDK uses the following priority order when determining which HTTP client to use:

Client-specific HTTP client (highest priority) - Set via constructor parameter or setHttpClient() method
Global HTTP client - Set in CommunicatorConfiguration
Default Guzzle client (lowest priority) - Used when no custom client is configured

This allows you to have a global configuration for most clients while still being able to customize specific clients when needed.

Backward Compatibility

The HTTP client customization feature maintains full backward compatibility:

Existing code continues to work without any changes
Default behavior remains unchanged when no custom HTTP client is provided
All existing tests continue to pass

Common Use Cases

Corporate Environment with Proxy

$corporateClient = new Client([
    'proxy' => getenv('CORPORATE_PROXY'),
    'timeout' => 45,
    'verify' => '/etc/ssl/certs/ca-certificates.crt'
]);

Development Environment with Debugging

$debugClient = new Client([
    'timeout' => 120,  // Longer timeout for debugging
    'debug' => true,   // Enable debug output
    'verify' => false  // Disable SSL verification for local testing
]);

Production Environment with Monitoring

$stack = HandlerStack::create();
$stack->push(Middleware::mapRequest(function ($request) {
    // Log request metrics to monitoring system
    return $request;
}));

$productionClient = new Client([
    'handler' => $stack,
    'timeout' => 15,
    'connect_timeout' => 5
]);

back to top

Authentication Token Retrieval

To interact with certain client-side SDKs (such as the credit card tokenizer), you need to generate a short-lived authentication JWT token for your merchant. This token can be retrieved using the SDK as follows:

<?php

use PayoneCommercePlatform\Sdk\ApiClient\AuthenticationApiClient;
use PayoneCommercePlatform\Sdk\CommunicatorConfiguration;

$apiKey = getenv('API_KEY');
$apiSecret = getenv('API_SECRET');
$merchantId = getenv('MERCHANT_ID');

$config = new CommunicatorConfiguration(
    apiKey: $apiKey,
    apiSecret: $apiSecret,
    integrator: 'YOUR COMPANY NAME'
);
$authClient = new AuthenticationApiClient($config);

$token = $authClient->getAuthenticationTokens($merchantId);
echo "JWT Token: " . $token->getToken() . "\n";
echo "Token ID: " . $token->getId() . "\n";
echo "Created: " . $token->getCreationDate() . "\n";
echo "Expires: " . $token->getExpirationDate() . "\n";

This token can then be used for secure operations such as initializing the credit card tokenizer or other client-side SDKs that require merchant authentication. The token is valid for a limited time (10 minutes) and should be handled securely.

Note: The getAuthenticationTokens method requires a valid merchantId. Optionally, you can provide an X-Request-ID header for tracing requests.

back to top

Demo App

This repository contains a demo app that showcases how to implement common use cases, like a Step-by-Step Checkout and an One-Stop-Checkout. For each use case the demo app contains a protected method in the top level class DemoApp. You can run the app to execute the code within in the sandbox API. This is a good way to test, if your setup is correct.

Before running the app ensure you have run composer install and composer dumb-autoload within the demo app directory (./examples/demo-app). By default, all API calls are sent to the pre-production environment of the PAYONE Commerce Platform. Note that the created entities cannot be completely deleted.

You can run it within the demo app directory via php src/DemoApp.php, make sure to provide all necessary environment variables:

API_KEY a valid api key for the PAYONE Commerce Platform
API_SECRET a valid api secret for the PAYONE Commerce Platform
MERCHANT_ID the merchant id which is needed to identify entities, e.g. commerce cases and checkouts, that belong to you.

Jump to the demo app

back to top

API Reference

All contents of this SDK are availble under the namespace PayoneCommercePlatform\Sdk. The SDK groups the endpoints of every resource into its own client, e.g. the PayoneCommercePlatform\Sdk\ApiClient\CheckoutApiClient can be used to interact with a checkout. To instantiate a singular client a PayoneCommercePlatform\Sdk\CommunicatorConfiguration instance has to provided which at least needs an API Key and Secret to connect to PAYONE Commerce Platform. The reponses and requests as well as their contained objects are provided as PHP classes and enums within the PayoneCommercePlatform\Sdk\Models namespace.

CommunicatorConfiguration

The CommunicatorConfiguration class is responsible for configuring the connection to the PAYONE Commerce Platform. This class holds essential information such as API keys, host URLs, and metadata required to authenticate and interact with the platform's API. Its needed as configuration to interact with any of the resources. Ensure that the API key and secret are securely stored and only passed to the configuration instance when needed.

Setup your configuration

To create a configuration object apiKey and apiSecret are required. You can use CommunicatorConfiguration::getPredefinedHosts() to get information about different environments of the PAYONE Commerce Platform. Currently prod and preprod are available. You should also provide an integrator as a string, this helps us in debugging and monitoring process.

<?php

use PayoneCommercePlatform\Sdk\CommunicatorConfiguration;

/** @var CommunicatorConfiguration */
$config = new CommunicatorConfiguration(
        apiKey: getenv('API_KEY'),
        apiSecret: getenv('API_SECRET'),
        host: CommunicatorConfiguration::getPredefinedHosts()['prod']['url'],
        integrator: 'YOUR COMPANY NAME',
);

You shouldn't need to provide serverMetaInfo. This property can automatically be detected. and will send your OS, PHP Version and SDK to the PCP for debugging purposes.

Constants

SDK_VERSION
Description: The version of the SDK. type: string

Methods

`__construct`

public function __construct(
    string $apiKey,
    string $apiSecret,
    ?string $host = null,
    ?string $integrator = null,
    ?array $serverMetaInfo = null,
    ?array $clientMetaInfo = null
)

Description:
Constructor to initialize the configuration with required and optional parameters.

Parameters:

string $apiKey: The API key for authentication.
string $apiSecret: The API secret for authentication.
string|null $host: The host URL for the PAYONE Commerce Platform API. Defaults to the production URL if not provided.
string|null $integrator: Information about the integrator using the SDK.
array|null $serverMetaInfo: Metadata about the server environment.
array|null $clientMetaInfo: Metadata about the client environment.

`setApiKey`

public function setApiKey(string $apiKey): self

Description:
Sets the API key.

Parameters:

string $apiKey: The API key for authentication.

Returns:
self

`getApiKey`

public function getApiKey(): string

Description:
Gets the API key.

Returns:
string - The API key.

`setApiSecret`

public function setApiSecret(string $apiSecret): self

Description:
Sets the API secret.

Parameters:

string $apiSecret: The API secret for authentication.

Returns:
self

`getApiSecret`

public function getApiSecret(): string

Description:
Gets the API secret.

Returns:
string - The API secret.

`getIntegrator`

public function getIntegrator(): ?string

Description:
Gets the integrator information.

Returns:
string|null - The integrator information, or null if not set.

`setIntegrator`

public function setIntegrator(?string $integrator): self

Description:
Sets the integrator information.

Parameters:

string|null $integrator: The integrator information.

Returns:
self

`setHost`

public function setHost(string $host): self

Description:
Sets the host URL. Automatically removes any trailing slash from the provided URL.

Parameters:

string $host: The host URL for the PAYONE Commerce Platform API.

Returns:
self

`getHost`

public function getHost(): string

Description:
Gets the host URL.

Returns:
string - The host URL.

`getClientMetaInfo`

public function getClientMetaInfo(): array

Description:
Gets the client metadata information.

Returns:
array<string, string> - The client metadata information.

`setClientMetaInfo`

public function setClientMetaInfo(array $clientMetaInfo): self

Description:
Sets the client metadata information.

Parameters:

array<string, string> $clientMetaInfo: The client metadata information.

Returns:
self

`addClientMetaInfo`

public function addClientMetaInfo(string $key, string $value): self

Description:
Adds an entry to the client metadata information.

Parameters:

string $key: The key for the metadata entry.
string $value: The value for the metadata entry.

Returns:
self

`getServerMetaInfo`

public function getServerMetaInfo(): array

Description:
Gets the server metadata information.

Returns:
array<string, string> - The server metadata information.

`setServerMetaInfo`

public function setServerMetaInfo(array $serverMetaInfo): self

Description:
Sets the server metadata information.

Parameters:

array<string, string> $serverMetaInfo: The server metadata information.

Returns:
self

`addServerMetaInfo`

public function addServerMetaInfo(string $key, string $value): self

Description:
Adds an entry to the server metadata information.

Parameters:

string $key: The key for the metadata entry.
string $value: The value for the metadata entry.

Returns:
self

`getPredefinedHosts`

public static function getPredefinedHosts(): array

Description:
Gets an array of predefined host settings for the PAYONE Commerce Platform.

Returns:
array<string, array{url: string, description: string}> - An array of predefined host settings.

Queries

For the getCommerceCases() and getCheckouts() you set the query parameter by passing a PayoneCommercePlatform\Sdk\Models\GetCommerceCasesQuery or PayoneCommercePlatform\Sdk\Models\GetCheckoutsQuery respectively. These objects have typed properties which can be set to filter the results. The conversion from the object to a query string is done automatically by the SDK.

GetCommerceCasesQuery

The properties are directly mapped to the query parameters of the commerce case API

The GetCommerceCasesQuery class is used to build and structure query parameters when fetching commerce cases via the PAYONE Commerce Platform API. It allows you to filter and limit the results by various criteria such as date range, merchant details, checkout status, and payment channels.

`offset`

Type: int|null
Description: The offset of the first item in the result set. This is used for pagination.
Setter: public function setOffset(?int $offset): self
Getter: public function getOffset(): ?int

`size`

Type: int|null
Description: The maximum number of items to return in the result set. This is used for pagination.
Setter: public function setSize(?int $size): self
Getter: public function getSize(): ?int

`fromDate`

Type: DateTime|null
Description: The start date for filtering commerce cases.
Setter: public function setFromDate(?DateTime $fromDate): self
Getter: public function getFromDate(): ?DateTime

`toDate`

Type: DateTime|null
Description: The end date for filtering commerce cases.
Setter: public function setToDate(?DateTime $toDate): self
Getter: public function getToDate(): ?DateTime

`commerceCaseId`

Type: string|null
Description: The unique identifier for a commerce case.
Setter: public function setCommerceCaseId(?string $commerceCaseId): self
Getter: public function getCommerceCaseId(): ?string

`merchantReference`

Type: string|null
Description: A reference identifier provided by the merchant.
Setter: public function setMerchantReference(?string $merchantReference): self
Getter: public function getMerchantReference(): ?string

`merchantCustomerId`

Type: string|null
Description: The unique identifier of the customer as provided by the merchant.
Setter: public function setMerchantCustomerId(?string $merchantCustomerId): self
Getter: public function getMerchantCustomerId(): ?string

`includeCheckoutStatus`

Type: array<StatusCheckout>|null
Description: An array of StatusCheckout enums to filter commerce cases by checkout status.
Setter: public function setIncludeCheckoutStatus(?array $includeCheckoutStatus): self
Getter: public function getIncludeCheckoutStatus(): ?array

`includePaymentChannel`

Type: array<PaymentChannel>|null
Description: An array of PaymentChannel enums to filter commerce cases by payment channels.
Setter: public function setIncludePaymentChannel(?array $includePaymentChannel): self
Getter: public function getIncludePaymentChannel(): ?array

GetCheckoutsQuery

The properties are directly mapped to the query parameters of the checkout API

The GetCheckoutsQuery class is used to build and structure query parameters when fetching checkout data via the PAYONE Commerce Platform API. It allows you to filter and limit the results by various criteria such as date range, amounts, merchant details, checkout statuses, and payment channels.

`offset`

Type: int|null
Description: The offset of the first item in the result set. This is used for pagination.
Setter: public function setOffset(?int $offset): self
Getter: public function getOffset(): ?int

`size`

Type: int|null
Description: The maximum number of items to return in the result set. This is used for pagination.
Setter: public function setSize(?int $size): self
Getter: public function getSize(): ?int

`fromDate`

Type: DateTime|null
Description: The start date for filtering checkouts.
Setter: public function setFromDate(?DateTime $fromDate): self
Getter: public function getFromDate(): ?DateTime

`toDate`

Type: DateTime|null
Description: The end date for filtering checkouts.
Setter: public function setToDate(?DateTime $toDate): self
Getter: public function getToDate(): ?DateTime

`fromCheckoutAmount`

Type: int|null
Description: The minimum checkout amount for filtering.
Setter: public function setFromCheckoutAmount(?int $fromCheckoutAmount): self
Getter: public function getFromCheckoutAmount(): ?int

`toCheckoutAmount`

Type: int|null
Description: The maximum checkout amount for filtering.
Setter: public function setToCheckoutAmount(?int $toCheckoutAmount): self
Getter: public function getToCheckoutAmount(): ?int

`fromOpenAmount`

Type: int|null
Description: The minimum open amount for filtering.
Setter: public function setFromOpenAmount(?int $fromOpenAmount): self
Getter: public function getFromOpenAmount(): ?int

`toOpenAmount`

Type: int|null
Description: The maximum open amount for filtering.
Setter: public function setToOpenAmount(?int $toOpenAmount): self
Getter: public function getToOpenAmount(): ?int

`fromCollectedAmount`

Type: int|null
Description: The minimum collected amount for filtering.
Setter: public function setFromCollectedAmount(?int $fromCollectedAmount): self
Getter: public function getFromCollectedAmount(): ?int

`toCollectedAmount`

Type: int|null
Description: The maximum collected amount for filtering.
Setter: public function setToCollectedAmount(?int $toCollectedAmount): self
Getter: public function getToCollectedAmount(): ?int

`fromCancelledAmount`

Type: int|null
Description: The minimum cancelled amount for filtering.
Setter: public function setFromCancelledAmount(?int $fromCancelledAmount): self
Getter: public function getFromCancelledAmount(): ?int

`toCancelledAmount`

Type: int|null
Description: The maximum cancelled amount for filtering.
Setter: public function setToCancelledAmount(?int $toCancelledAmount): self
Getter: public function getToCancelledAmount(): ?int

`fromRefundAmount`

Type: int|null
Description: The minimum refund amount for filtering.
Setter: public function setFromRefundAmount(?int $fromRefundAmount): self
Getter: public function getFromRefundAmount(): ?int

`toRefundAmount`

Type: int|null
Description: The maximum refund amount for filtering.
Setter: public function setToRefundAmount(?int $toRefundAmount): self
Getter: public function getToRefundAmount(): ?int

`fromChargebackAmount`

Type: int|null
Description: The minimum chargeback amount for filtering.
Setter: public function setFromChargebackAmount(?int $fromChargebackAmount): self
Getter: public function getFromChargebackAmount(): ?int

`toChargebackAmount`

Type: int|null
Description: The maximum chargeback amount for filtering.
Setter: public function setToChargebackAmount(?int $toChargebackAmount): self
Getter: public function getToChargebackAmount(): ?int

`checkoutId`

Type: string|null
Description: The unique identifier of the checkout.
Setter: public function setCheckoutId(?string $checkoutId): self
Getter: public function getCheckoutId(): ?string

`merchantReference`

Type: string|null
Description: A reference identifier provided by the merchant.
Setter: public function setMerchantReference(?string $merchantReference): self
Getter: public function getMerchantReference(): ?string

`merchantCustomerId`

Type: string|null
Description: The unique identifier of the customer as provided by the merchant.
Setter: public function setMerchantCustomerId(?string $merchantCustomerId): self
Getter: public function getMerchantCustomerId(): ?string

`includePaymentProductId`

Type: array<string>|null
Description: An array of payment product IDs to include in the search.
Setter: public function setIncludePaymentProductId(?array $includePaymentProductId): self
Getter: public function getIncludePaymentProductId(): ?array

`includeCheckoutStatus`

Type: array<StatusCheckout>|null
Description: An array of StatusCheckout enums to filter checkouts by status.
Setter: public function setIncludeCheckoutStatus(?array $includeCheckoutStatus): self
Getter: public function getIncludeCheckoutStatus(): ?array

`includeExtendedCheckoutStatus`

Type: array<ExtendedCheckoutStatus>|null
Description: An array of ExtendedCheckoutStatus enums to filter checkouts by extended status.
Setter: public function setIncludeExtendedCheckoutStatus(?array $includeExtendedCheckoutStatus): self
Getter: public function getIncludeExtendedCheckoutStatus(): ?array

`includePaymentChannel`

Type: array<PaymentChannel>|null
Description: An array of PaymentChannel enums to filter checkouts by payment channel.
Setter: public function setIncludePaymentChannel(?array $includePaymentChannel): self
Getter: public function getIncludePaymentChannel(): ?array

`paymentReference`

Type: string|null
Description: The payment reference for filtering.
Setter: public function setPaymentReference(?string $paymentReference): self
Getter: public function getPaymentReference(): ?string

`paymentId`

Type: string|null
Description: The payment ID for filtering.
Setter: public function setPaymentId(?string $paymentId): self
Getter: public function getPaymentId(): ?string

`firstName`

Type: string|null
Description: The first name of the customer for filtering.
Setter: public function setFirstName(?string $firstName): self
Getter: public function getFirstName(): ?string

`surname`

Type: string|null
Description: The surname of the customer for filtering.
Setter: public function setSurname(?string $surname): self
Getter: public function getSurname(): ?string

`email`

Type: string|null
Description: The email of the customer for filtering.
Setter: public function setEmail(?string $email): self
Getter: public function getEmail(): ?string

`phoneNumber`

Type: string|null
Description: The phone number of the customer for filtering.
Setter: public function setPhoneNumber(?string $phoneNumber): self
Getter: public function getPhoneNumber(): ?string

`dateOfBirth`

Type: string|null
Description: The date of birth of the customer for filtering.
Setter: public function setDateOfBirth(?string $dateOfBirth): self
Getter: public function getDateOfBirth(): ?string

`companyInformation`

Type: string|null
Description: The company information for filtering.
Setter: public function setCompanyInformation(?string $companyInformation): self
Getter: public function getCompanyInformation(): ?string

`terminalId`

Type: string|null
Description: The terminal id for filtering.
Setter: public function setTerminalId(?string $terminalId): self
Getter: public function getTerminalId(): ?string

`reportingToken`

Type: string|null
Description: The reporting token für filtering.
Setter: public function setReportingToken(?string $reportingToken): self
Getter: public function getReportingToken(): ?string

API Clients

There's a API client class for each resource:

PayoneCommercePlatform\Sdk\ApiClient\CheckoutApiClient
PayoneCommercePlatform\Sdk\ApiClient\CommerceCaseApiClient
PayoneCommercePlatform\Sdk\ApiClient\OrderManagementCheckoutActionsApiClient
PayoneCommercePlatform\Sdk\ApiClient\PaymentExecutionApiClient
PayoneCommercePlatform\Sdk\ApiClient\PaymentInformationApiClient

BaseApiClient

All clients inherit from PayoneCommercePlatform\Sdk\ApiClient\BaseApiClient. You may want to use its static methods to serialize and deserialize JSON strings to models from this SDK. The respective methods serializeJson() and deserializeJson() are available on every client class as static methods as well. Note that these methods have undefined behavior when used with classes that are not part of this SDK.

Static Methods

`deserializeJson`

Description:
A generic function that deserializes a JSON string into an instance of the specified class type.

Parameters:

string $data: The JSON string to deserialize.
class-string<T>: The fully qualified class name of the type to deserialize the JSON string into.

Returns:

T - An instance of the specified class type

Exceptions:

NotEncodableValueException
UnexpectedValueException

`serializeJson`

Description: Serializes an object or array into a JSON string. The method ensures that empty objects are serialized as '{}' rather than '[]'. Any property that itself maybe a model from the PayoneCommercePlatform\Sdk\Models namespace or an array of models is resursively serialized. T

Parameters:

mixed $data: The data to be serialized into a JSON string.

Returns: string: A JSON string representing the input data.

CheckoutApiClient

The CheckoutApiClient class provides methods to interact with the Checkout resource of the PAYONE Commerce Platform API. This includes creating, updating, retrieving, and deleting checkouts within a commerce case.

You can create a CheckoutApiClient by providing a CommunicatorConfiguration. All endpoints are directly exposed as methods on the instance.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\CheckoutApiClient;

$config = new CommunicatorConfiguration('API_KEY', 'API_SECRET');
$client = new CheckoutApiClient($config);

Methods

`createCheckout`

public function createCheckout(
    string $merchantId,
    string $commerceCaseId,
    CreateCheckoutRequest $createCheckoutRequest
): CreateCheckoutResponse

Description:
Creates a new checkout within an existing commerce case.

Parameters:

string $merchantId: The unique identifier of the merchant. A Checkout is associated with exactly one merchant.
string $commerceCaseId: The unique identifier of a commerce case.
CreateCheckoutRequest $createCheckoutRequest: The request body containing details for creating the checkout.

Returns:
CreateCheckoutResponse - The response object containing details of the created checkout.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`deleteCheckout`

public function deleteCheckout(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId
): void

Description:
Deletes an existing checkout.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a commerce case.
string $checkoutId: The unique identifier of the checkout to be deleted.

Returns:
void

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`getCheckout`

public function getCheckout(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId
): CheckoutResponse

Description:
Retrieves details of a specific checkout.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a commerce case.
string $checkoutId: The unique identifier of the checkout to retrieve.

Returns:
CheckoutResponse - The response object containing details of the retrieved checkout.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`getCheckouts`

public function getCheckouts(
    string $merchantId,
    GetCheckoutsQuery $query = new GetCheckoutsQuery()
): CheckoutsResponse

Description:
Retrieves a list of checkouts based on the provided search parameters.

Parameters:

string $merchantId: The unique identifier of the merchant.
GetCheckoutsQuery $query: The query parameters used to filter the checkouts.

Returns:
CheckoutsResponse - The response object containing a list of checkouts that match the search parameters.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`updateCheckout`

public function updateCheckout(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    PatchCheckoutRequest $patchCheckoutRequest
): void

Description:
Modifies an existing checkout.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a commerce case.
string $checkoutId: The unique identifier of the checkout to be updated.
PatchCheckoutRequest $patchCheckoutRequest: The request body containing the modifications to be applied to the checkout.

Returns:
void

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`completeCheckout`

public function completeCheckout(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    CompleteOrderRequest $completeOrderRequest
): CompletePaymentResponse

Description:
Completes an already existing Order.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a commerce case.
string $checkoutId: The unique identifier of the checkout to be updated.
CompleteOrderRequest $completeOrderRequest: The request body containing the selected installmentOptionId as well as the bankAccountInformation of the customer.

Returns:
CompletePaymentResponse - The response object containing the details of the created payment, the merchant actions, including the needed data, that you should perform next to complete the payment and an object that holds the payment related properties.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

CommerceCaseApiClient

The CommerceCaseApiClient class provides methods to interact with the Commerce Case resource of the PAYONE Commerce Platform API. This includes creating, updating, retrieving, and searching commerce cases.

You can create a CommerceCaseApiClient by providing a CommunicatorConfiguration. All endpoints are directly exposed as methods on the instance.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\CommerceCaseApiClient;

$config = new CommunicatorConfiguration('API_KEY', 'API_SECRET');
$client = new CommerceCaseApiClient($config);

Methods

`createCommerceCase`

public function createCommerceCase(
    string $merchantId,
    CreateCommerceCaseRequest $createCommerceCaseRequest
): CreateCommerceCaseResponse

Description:
Creates a new commerce case for a specified merchant.

Parameters:

string $merchantId: The unique identifier of the merchant. A Commerce Case is associated with exactly one merchant.
CreateCommerceCaseRequest $createCommerceCaseRequest: The request body containing details for creating the commerce case.

Returns:
CreateCommerceCaseResponse - The response object containing details of the created commerce case.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`getCommerceCase`

public function getCommerceCase(
    string $merchantId,
    string $commerceCaseId
): CommerceCaseResponse

Description:
Retrieves details of a specific commerce case.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of the commerce case to retrieve.

Returns:
CommerceCaseResponse - The response object containing details of the retrieved commerce case.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`getCommerceCases`

public function getCommerceCases(
    string $merchantId,
    GetCommerceCasesQuery $query = new GetCommerceCasesQuery()
): array

Description:
Retrieves a list of commerce cases based on the provided search parameters.

Parameters:

string $merchantId: The unique identifier of the merchant.
GetCommerceCasesQuery $query: The query parameters used to filter the commerce cases.

Returns:
array<CommerceCaseResponse> - An array of CommerceCaseResponse objects representing the retrieved commerce cases.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`updateCommerceCase`

public function updateCommerceCase(
    string $merchantId,
    string $commerceCaseId,
    Customer $customer
): void

Description:
Updates an existing commerce case with new customer information.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of the commerce case to update.
Customer $customer: The customer data to update in the commerce case.

Returns:
void

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

OrderManagementCheckoutActionsApiClient

The OrderManagementCheckoutActionsApiClient class provides methods to manage orders related to checkouts within a commerce case. This includes operations such as creating, canceling, delivering, and returning orders.

You can create a OrderManagementCheckoutActionsApiClient by providing a CommunicatorConfiguration. All endpoints are directly exposed as methods on the instance.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\OrderManagementCheckoutActionsApiClient;

$config = new CommunicatorConfiguration('API_KEY', 'API_SECRET');
$client = new OrderManagementCheckoutActionsApiClient($config);

Methods

`cancelOrder`

public function cancelOrder(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    ?CancelRequest $cancelRequest = null
): CancelResponse

Description:
Marks items of a Checkout as canceled and automatically cancels the payment associated with those items.

Parameters:

string $merchantId: The unique identifier of the merchant. A Checkout is associated with exactly one merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
CancelRequest|null $cancelRequest: The request body containing details for the cancellation (optional).

Returns:
CancelResponse - The response object containing details of the canceled order.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`createOrder`

public function createOrder(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    OrderRequest $orderRequest
): OrderResponse

Description:
Creates an order that will automatically execute a payment.

Parameters:

string $merchantId: The unique identifier of the merchant. A Checkout is associated with exactly one merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
OrderRequest $orderRequest: The request body containing details for creating the order.

Returns:
OrderResponse - The response object containing details of the created order.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`deliverOrder`

public function deliverOrder(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    DeliverRequest $deliverRequest
): DeliverResponse

Description:
Marks items of a Checkout as delivered and automatically captures the payment associated with those items.

Parameters:

string $merchantId: The unique identifier of the merchant. A Checkout is associated with exactly one merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
DeliverRequest $deliverRequest: The request body containing details for delivering the order.

Returns:
DeliverResponse - The response object containing details of the delivered order.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`returnOrder`

public function returnOrder(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    ?ReturnRequest $returnRequest = null
): ReturnResponse

Description:
Marks items of a Checkout as returned and automatically refunds the payment associated with those items.

Parameters:

string $merchantId: The unique identifier of the merchant. A Checkout is associated with exactly one merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
ReturnRequest|null $returnRequest: The request body containing details for the return (optional).

Returns:
ReturnResponse - The response object containing details of the returned order.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

PaymentExecutionApiClient

The PaymentExecutionApiClient class provides methods to manage the execution of payments within a commerce case. This includes operations such as creating, canceling, capturing, completing, and refunding payments.

You can create a PaymentExecutionApiClient by providing a CommunicatorConfiguration. All endpoints are directly exposed as methods on the instance.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\PaymentExecutionApiClient;

$config = new CommunicatorConfiguration('API_KEY', 'API_SECRET');
$client = new PaymentExecutionApiClient($config);

Methods

####### cancelPaymentExecution

public function cancelPaymentExecution(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentExecutionId,
    CancelPaymentRequest $cancelPaymentRequest
): CancelPaymentResponse

Description:
Cancels a payment that has been previously executed.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentExecutionId: The unique identifier of a payment execution.
CancelPaymentRequest $cancelPaymentRequest: The request body containing details for the payment cancellation.

Returns:
CancelPaymentResponse - The response object containing details of the canceled payment.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`capturePaymentExecution`

public function capturePaymentExecution(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentExecutionId,
    CapturePaymentRequest $capturePaymentRequest
): CapturePaymentResponse

Description:
Captures a payment that has been authorized but not yet captured.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentExecutionId: The unique identifier of a payment execution.
CapturePaymentRequest $capturePaymentRequest: The request body containing details for the payment capture.

Returns:
CapturePaymentResponse - The response object containing details of the captured payment.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`completePayment`

public function completePayment(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentExecutionId,
    CompletePaymentRequest $completePaymentRequest
): CompletePaymentResponse

Description:
Completes a payment that has been partially processed or requires finalization.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentExecutionId: The unique identifier of a payment execution.
CompletePaymentRequest $completePaymentRequest: The request body containing details for completing the payment.

Returns:
CompletePaymentResponse - The response object containing details of the completed payment.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`createPayment`

public function createPayment(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    PaymentExecutionRequest $paymentExecutionRequest
): CreatePaymentResponse

Description:
Creates a new payment execution for a checkout.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
PaymentExecutionRequest $paymentExecutionRequest: The request body containing details for the payment execution.

Returns:
CreatePaymentResponse - The response object containing details of the created payment execution.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`refundPaymentExecution`

public function refundPaymentExecution(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentExecutionId,
    RefundRequest $refundRequest
): RefundPaymentResponse

Description:
Refunds a payment that has been previously captured.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentExecutionId: The unique identifier of a payment execution.
RefundRequest $refundRequest: The request body containing details for the payment refund.

Returns:
RefundPaymentResponse - The response object containing details of the refunded payment.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`pausePayment`

public function pausePayment(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentExecutionId,
    PausePaymentRequest $pausePaymentRequest
): PausePaymentResponse

Description:
Pauses a payment for selected payment methods.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentExecutionId: The unique identifier of a payment execution.
PausePaymentRequest $pausePaymentRequest: The request body containing details to pause a payment for a specific payment method.

Returns:
PausePaymentResponse - The response object containing a current high-level status of the payment in a human-readable form.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`refreshPayment`

public function refreshPayment(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentExecutionId,
    RefreshPaymentRequest $refreshPaymentRequest
): PaymentExecution

Description:
Pauses a payment for selected payment methods.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentExecutionId: The unique identifier of a payment execution.
RefreshPaymentRequest $refreshPaymentRequest: The request body containing the refresh type.

Returns:
PaymentExecution - The response object containing the information of the payment.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

PaymentInformationApiClient

The PaymentInformationApiClient class provides methods to create and retrieve payment information associated with a commerce case and a checkout.

You can create a PaymentInformationApiClient by providing a CommunicatorConfiguration. All endpoints are directly exposed as methods on the instance.

<?php

use PayoneCommercePlatform\Sdk\ApiClient\PaymentInformationApiClient;

$config = new CommunicatorConfiguration('API_KEY', 'API_SECRET');
$client = new PaymentInformationApiClient($config);

Methods

`createPaymentInformation`

public function createPaymentInformation(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    PaymentInformationRequest $paymentInformationRequest
): PaymentInformationResponse

Description:
Creates a new payment information record associated with a specific checkout.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
PaymentInformationRequest $paymentInformationRequest: The request body containing details for creating the payment information.

Returns:
PaymentInformationResponse - The response object containing details of the created payment information.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`getPaymentInformation`

public function getPaymentInformation(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentInformationId
): PaymentInformationResponse

Description:
Retrieves details of an existing payment information record associated with a specific checkout.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentInformationId: The unique identifier of the payment information.

Returns:
PaymentInformationResponse - The response object containing details of the payment information.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

`refundPaymentInformation`

public function refundPaymentInformation(
    string $merchantId,
    string $commerceCaseId,
    string $checkoutId,
    string $paymentInformationId,
    PaymentInformationRefundRequest $paymentInformationRefundRequest
): PaymentInformationRefundResponse

Description:
Initiate an online refund for a POS terminal transaction. The platform will automatically detect the payment method of the original transaction and select the most appropriate mode to refund the transaction.

Parameters:

string $merchantId: The unique identifier of the merchant.
string $commerceCaseId: The unique identifier of a Commerce Case.
string $checkoutId: The unique identifier of a Checkout.
string $paymentInformationId: The unique identifier of the payment information.
PaymentInformationRefundRequest $paymentInformationRefundRequest: The request body containing information about amount and currency, reference properties that are linked to this transaction and the account holder of the bank account.

Returns:
PaymentInformationResponse - The response object containing details of the payment related properties for the refund of a Payment Information and a reference to the paymentExecution.

Exceptions:

ApiErrorResponseException
ApiResponseRetrievalException

back to top

Contributing

See Contributing

back to top

Development

Ensure you have PHP 8.2 or higher installed. You will need composer and xdebug. A pretty version of the coverage report will be placed in coverage, after running composer run-script coverage-report.

Structure of this repository

This repository consists out of the following components:

The source code of the SDK itself: /src
The source code of the unit and integration tests (including the examples): /tests
The source code for demos is located examples/*. Make sure to run composer install and composer dumb-autoload before. Within the specific demo before launching it.

Release

This SDK follows semantic versioning (semver). To relase a new version, create a branch release/X.Y.Z and run prepare_release.sh X.Y.Z. The script automatically updates the SDK_VERSION property within the CommunicatorConfiguration class and the version field in the root composer.json, package.json and package-lock.json file. After that the changes are automatically committed and tagged as vX.Y.Z.

After calling the prepare_release.sh script, it is recommended to manually trigger the changelog generation script (which uses conventional-changelog).

Conventional Commit Messages:
- Ensure all commit messages follow the conventional commit format, which helps in automatic changelog generation.
- Commit messages should be in the format: type(scope): subject.
Enforcing Commit Messages:
- We enforce conventional commit messages using Lefthook with commitlint.
- This setup ensures that all commit messages are validated before they are committed.
Generate Changelog:
- Run the changelog generation script to update the CHANGELOG.md file:
```
npm run changelog
```
- Review and commit the updated changelog before proceeding with the release.

When the release is ready, a PR should be created for release branch. Select develop as the base branch. After merging into develop, merge develop into main.

Optional: Creating a GitHub Release

Once you've pushed your latest changes to the repository, developers can start using the latest version by pulling it from GitHub. However, to make the release more visible and provide detailed release notes, you can optionally create a GitHub release.

Navigate to the Releases Page: Go to the "Releases" section of your repository on GitHub.
Draft a New Release: Click "Draft a new release".
Tag the Release: Select the version tag that corresponds to the commit you want to release (e.g., v0.1.0). If the tag doesn't exist, you can create it here.
Release Title: Add a descriptive title for the release (e.g., v0.1.0 - Initial Release).
Auto-Generated Release Notes: GitHub can automatically generate release notes based on merged pull requests and commit history. You can review these notes, adjust the content, and highlight important changes.
Publish the Release: Once you're satisfied with the release notes, click "Publish release".

Creating a GitHub release is optional but beneficial, as it provides additional context and visibility for your users. Developers can then reference this specific release tag in their composer.json file when adding the package as a dependency.

For detailed guidance, refer to the GitHub documentation on managing releases.

back to top

License

This project is licensed under the MIT License - see the LICENSE file for details.

back to top

Thank you for using our SDK for Online Payments! If you have any questions or need further assistance, feel free to open an issue or contact us.

payone-gmbh / pcp-serversdk-php

Maintainers

Package info

Statistics

Security

README

Table of Contents

Requirements

Installation

Usage

General

Error Handling

Client Side

Apple Pay

HTTP Client Customization

Overview

Global HTTP Client Configuration

Client-Specific HTTP Client Configuration

Advanced Configuration Examples

HTTP Client with Middleware

Proxy Configuration

Priority Logic

Backward Compatibility

Common Use Cases

Corporate Environment with Proxy

Development Environment with Debugging

Production Environment with Monitoring

Authentication Token Retrieval

Demo App

API Reference

CommunicatorConfiguration

Setup your configuration

Constants

Methods

__construct

setApiKey

getApiKey

setApiSecret

getApiSecret

getIntegrator

setIntegrator

setHost

getHost

getClientMetaInfo

setClientMetaInfo

addClientMetaInfo

getServerMetaInfo

setServerMetaInfo

addServerMetaInfo

getPredefinedHosts

Queries

GetCommerceCasesQuery

offset

size

fromDate

toDate

commerceCaseId

merchantReference

merchantCustomerId

includeCheckoutStatus

includePaymentChannel

GetCheckoutsQuery

offset

size

fromDate

toDate

fromCheckoutAmount

toCheckoutAmount

fromOpenAmount

toOpenAmount

fromCollectedAmount

toCollectedAmount

fromCancelledAmount

toCancelledAmount

fromRefundAmount

toRefundAmount

fromChargebackAmount

toChargebackAmount

checkoutId

merchantReference

`__construct`

`setApiKey`

`getApiKey`

`setApiSecret`

`getApiSecret`

`getIntegrator`

`setIntegrator`

`setHost`

`getHost`

`getClientMetaInfo`

`setClientMetaInfo`

`addClientMetaInfo`

`getServerMetaInfo`

`setServerMetaInfo`

`addServerMetaInfo`

`getPredefinedHosts`

`offset`

`size`

`fromDate`

`toDate`

`commerceCaseId`

`merchantReference`

`merchantCustomerId`

`includeCheckoutStatus`

`includePaymentChannel`

`offset`

`size`

`fromDate`

`toDate`

`fromCheckoutAmount`

`toCheckoutAmount`

`fromOpenAmount`

`toOpenAmount`

`fromCollectedAmount`

`toCollectedAmount`

`fromCancelledAmount`

`toCancelledAmount`

`fromRefundAmount`

`toRefundAmount`

`fromChargebackAmount`

`toChargebackAmount`

`checkoutId`

`merchantReference`

`merchantCustomerId`

`includePaymentProductId`

`includeCheckoutStatus`

`includeExtendedCheckoutStatus`

`includePaymentChannel`

`paymentReference`

`paymentId`

`firstName`

`surname`

`email`

`phoneNumber`

`dateOfBirth`

`companyInformation`

`terminalId`

`reportingToken`

`deserializeJson`

`serializeJson`

`createCheckout`

`deleteCheckout`

`getCheckout`

`getCheckouts`

`updateCheckout`

`completeCheckout`

`createCommerceCase`

`getCommerceCase`

`getCommerceCases`

`updateCommerceCase`

`cancelOrder`

`createOrder`

`deliverOrder`

`returnOrder`

`capturePaymentExecution`

`completePayment`

`createPayment`

`refundPaymentExecution`

`pausePayment`

`refreshPayment`