NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist
Packagist, #3086 most downloaded on Packagist
Checkout.com SDK for PHP
Latest stable
6.11.0
Last release 12 days ago
10 Nov 2026
Ships on a steady schedule
a new release about every 2 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
8 years old
104 releases · first in 2019
Drag across the ruler to compare, or tap a release to open it.
Release 6.11.0 - security hardening
Release 6.11.0 - security hardening (#418)
This release brings security hardening and input validation for request URLs. Please check the behaviour changes before upgrading.
Release 6.10.0 - security hardening
Release 6.10.0 - security hardening (#411)
This release brings security hardening and raises dependency minimums. Please check the new requirements before upgrading.
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Breaking changes required by the API :warning:
Release 6.9.1 (#405)
This release completes the Payment Setups request model with the 29 missing payment methods, billing and a dedicated payment type (#398). It adds card, token and network token payout destinations, unreferenced refunds and the remaining payout and payment request fields (#401), and fixes customer_retry on hosted payments, payment links and payment sessions so max_attempts can be sent (#400). Members that the API no longer accepts in requests are deprecated, not removed.
Added
Payment Setups (#398)
PaymentMethods, each with its own class under Checkout\Payments\Setups\Common\PaymentMethods: $ach (Ach), $alipay_cn (AlipayCn), $alipay_hk (AlipayHk), $alma (Alma), $bancontact (Bancontact), $benefit (Benefit), $blik (Blik), $dana (Dana), $eps (Eps), $gcash (GCash), $ideal (Ideal), $kakaopay (KakaoPay), $knet (Knet), $mbway (MbWay), $mobilepay (MobilePay), $multibanco (Multibanco), $octopus (Octopus), $p24 (P24), $paynow (PayNow), $qpay (Qpay), $sepa (Sepa), $sequra (Sequra), $swish (Swish), $tamara (Tamara), $tng (Tng), $truemoney (TrueMoney), $twint (Twint), $vipps (Vipps), $wechatpay (WeChatPay).AchAccountHolder, AchAccountHolderIdentification, P24AccountHolder, SwishAccountHolder, SepaAccountHolder, SepaMandate, TamaraRiskAssessment.KnetLanguage, AchAccountHolderType, PaymentSetupAchAccountType, SepaAccountHolderType, PaymentSetupSepaMandateType, PaymentSetupTerminalType, PaymentSetupOsType.PaymentSetupRequest::$billing with the new PaymentSetupBilling class ($address).PaymentSetupPaymentType with the six Payment Setup values: regular, recurring, moto, installment, pay_later, unscheduled.Checkout\Common\EmptyAsObject, a class attribute that makes JsonSerializer write an object with nothing set as {} instead of [].Payouts and unreferenced refunds (#401)
PaymentsClient::requestUnreferencedRefund() and UnreferencedRefundRequest, sent to POST /payments with payment_type set to UnreferencedRefund.PaymentRequestCardDestination, PaymentRequestTokenDestination and PaymentRequestNetworkTokenDestination.PaymentDestinationType::$network_token.NetworkTokenType with vts, mdes, applepay and googlepay.PayoutRequest::$billing_descriptor (PayoutBillingDescriptor).Checkout\Payments\Request\PaymentInstruction::$remittance.PaymentSender::$reference, inherited by every sender type.PaymentBankAccountDestination::$bban.AccountHolderIdentification::$date_of_expiry.Payments (#401, #400)
PaymentType::$pay_later (PayLater) (#401).Checkout\Payments\PaymentInstruction::$purpose, for regular payments and payment sessions (#401).CustomerRetry with $max_attempts (0 to 5, default 5) (#400).Changed
RequestNetworkTokenSource::$token_type is documented as a NetworkTokenType value (#401).MerchantAccount::$last_payment_amount is documented as float instead of int, matching the API's number type (#398).customer_retry on HostedPaymentsSessionRequest, PaymentLinkRequest and PaymentSessionsRequest is documented as CustomerRetry instead of PaymentRetryRequest. Only the PHPDoc type changes; arrays such as ['max_attempts' => 3] keep working (#400).initialization docs now state that an update replaces the payment methods, so send enabled again to keep a method enabled (#398).Fixed
customer_retry on hosted payments, payment links and payment sessions can now carry max_attempts. It was typed as the retry object of POST /payments, whose enabled, dunning and downtime the API rejects in customer_retry. Use CustomerRetry (#400).Deprecated
All of these will be removed in the next major version.
Bizum::$initialization, PayByBank::$initialization and Stablecoin::$initialization (Payment Setups): not in their API schemas. No replacement (#398).Bizum::$payment_method_options (Payment Setups): not in the Bizum schema. No replacement (#398).AccountHolder::$gender: not in any request account holder schema. No replacement (#401).PaymentBankAccountDestination::$bank: not in the bank account payout destination schema. No replacement (#401).InstructionScheme::$swift: the request scheme only accepts local and instant. No replacement (#401).Checkout\Payments\Request\PaymentInstruction::$charge_bearer, $repair and $quote_id: not in the request schema. No replacement (#401).PayoutRequestSource::$amount: not in any payout or unreferenced refund source schema. No replacement (#401).PaymentRequest::$payment_ip: use risk.device.network.ipv4 or risk.device.network.ipv6 instead (#400).HostedPaymentsSessionRequest::$payment_ip and PaymentLinkRequest::$payment_ip: deprecated by the API. No replacement (#400).PaymentSessionsRequest::$ip_address: deprecated by the API. No replacement (#400).Breaking changes required by the API :warning:
{} instead of []; the API rejects [] with 422 <path>_property_invalid for most of these objects. This covers every class under Payments\Setups, including existing ones; objects with values and lists are sent as before. Migration: none needed unless your code depends on the [] output (#398).Breaking changes (SDK alignment) :warning:
PaymentSetupRequest::$payment_type defaults to "regular" instead of "Regular". The API accepts both. Migration: compare with PaymentSetupPaymentType::$regular instead of "Regular" (#398).This release improves dependency management and build consistency for the project by ensuring that Composer dependencies are always installed accordin
Release 6.8.1 (#399)
This release improves dependency management and build consistency for the project by ensuring that Composer dependencies are always installed according to the composer.lock file, rather than being re-resolved on each CI run. It also documents this approach and pins the PHP version used for dependency resolution. These changes enhance security and reliability in both CI and local development environments.
Dependency management and CI workflow improvements:
.github/workflows/build-master.yml and .github/workflows/build-release.yml to use composer install instead of composer update, ensuring that dependencies are installed exactly as specified in composer.lock and not re-resolved on each run. This reduces the risk of inadvertently introducing malicious or incompatible package versions during CI runs. [1] [2]config.platform.php setting with version 8.1 to composer.json to ensure consistent dependency resolution across different environments, matching the CI configuration.Documentation updates:
README.md to instruct users to run composer install (not composer update) for local development, ensuring local environments match CI and clarifying when to use each command.Payment setups: Pay by Bank is sent under the paybybank key; the previous key was ignored by the API. Adds the Pay by Bank risk object.
Release 6.8.0 (#395)
Deprecated:
This release introduces support for the Cash App payment method in the payment setup flow, along with enhancements to customer and device information
Release 6.7.0 (#390)
This release introduces support for the Cash App payment method in the payment setup flow, along with enhancements to customer and device information handling. It adds new model classes for Cash App-specific data, extends device and customer models with additional fields, and improves test coverage for these features. The main changes are grouped below.
Cash App Payment Method Integration:
CashApp payment method model, including support for customer profile sharing, actions, and customer profile details, with associated classes such as CashAppCustomerProfile, CashAppAddress, CashAppAction, and CashAppActionType. (lib/Checkout/Payments/Setups/Common/PaymentMethods/CashApp/CashApp.php [1] CashAppCustomerProfile.php [2] CashAppAddress.php [3] CashAppAction.php [4] CashAppActionType.php [5]CashApp payment method in the PaymentMethods class, allowing it to be serialized and used like other payment methods. (PaymentMethods.php [1] [2]Customer and Device Model Enhancements:
Customer model with new optional fields: id, country, and tax_number, improving support for customer identification and compliance. (Customer.php lib/Checkout/Payments/Setups/Common/Customer/Customer.phpR10-R65)Device model with new fields: fingerprint, ipv4, ipv6, client (with enum via DeviceClient), and os (with enum via DeviceOs), supporting richer device context for risk and eligibility checks. (Device.php [1] DeviceClient.php [2] DeviceOs.php [3]Payment Method Base Improvements:
status, flags, and initialization fields in PaymentMethodBase, including their possible values and usage. (PaymentMethodBase.php lib/Checkout/Payments/Setups/Common/PaymentMethods/Common/PaymentMethodBase.phpR8-R29)Test Coverage:
PaymentSetupsIntegrationTest.php test/Checkout/Tests/Payments/Setups/PaymentSetupsIntegrationTest.phpR143-R219)PaymentSetupsClientTest.php test/Checkout/Tests/Payments/Setups/PaymentSetupsClientTest.phpR118-R139)These changes collectively enable richer customer and device data handling and introduce full support for the Cash App payment method in the payment setup workflow.
This release introduces several new document classes and updates the structure and documentation of the Accounts API onboarding models to more accurat
Release 6.6.0 (#388)
This release introduces several new document classes and updates the structure and documentation of the Accounts API onboarding models to more accurately represent the requirements for different onboarding variants. The changes clarify where different types of documents should be attached (either at the top-level or on representatives), add detailed PHPDoc comments, and introduce new enums for document types. The most important changes are grouped below:
AdditionalDocument, CertifiedAuthorisedSignatory, FinancialVerification, ProofOfPrincipalAddress, ProofOfLegality, ProofOfRegistration, and ProofOfResidentialAddress, each with required fields and detailed documentation. [1] [2] [3] [4] [5] [6] [7]CertifiedAuthorisedSignatoryType, FinancialVerificationType, ProofOfPrincipalAddressType, ProofOfLegalityType, ProofOfRegistrationType, and ProofOfResidentialAddressType. [1] [2] [3] [4] [5] [6]RepresentativeDocuments class to strictly define the set of documents allowed on a representative, and updated the Representative class to use it instead of the general OnboardSubEntityDocuments. [1] [2]OnboardSubEntityDocuments to clarify which documents belong at the top level and which on representatives, and updated types for new document classes. [1] [2]Invitee class and related field in ContactDetails to represent the user responsible for onboarding. [1] [2]These changes improve the clarity, maintainability, and correctness of the onboarding document model in the Accounts API.
The changes include detailed docblocks for classes and properties, deprecation notices for outdated fields, and new or updated models for handling acc…
Release 6.5.0 (#386)
This release introduces comprehensive improvements to the PHP SDK's payment and processing data models, focusing on documentation clarity, alignment with API specifications, and enhanced support for accommodation and airline payment features. The changes include detailed docblocks for classes and properties, deprecation notices for outdated fields, and new or updated models for handling accommodation and airline data across different payment flows.
Documentation and Specification Alignment
AccommodationData, AccommodationGuest, AccommodationRoom, Passenger, FlightLegDetails, airline data classes) to clarify their purpose and usage. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12][Optional] markers, and provided detailed notes on API quirks, expected types, and backward compatibility. [1] [2] [3] [4] [5] [6]Accommodation and Airline Data Enhancements
AccommodationData (e.g., property_phone, customer_service_phone) and introduced the AccommodationPhone model to support richer accommodation contact details. [1] [2]plan instead of billing_plan, ticket/passenger as objects not arrays, use of shared models). [1] [2] [3]Deprecations and Backwards Compatibility
service_class in FlightLegDetails, PaymentContextsPartnerCustomerRiskData), with guidance on preferred alternatives. [1] [2]Schema and Model Corrections
PaymentSetupAccommodationAddress, PaymentSetupAccommodationRoom) where the schema differs from the main payment models. [1] [2]New Models
AccommodationPhone to encapsulate property and customer service phone details for accommodations.These changes significantly improve the maintainability, correctness, and clarity of the SDK's payment data models, making integration with the Checkout API more predictable and robust.
Release 6.4.0 - Add verification attempt-assets endpoints and card scheduled_activation_date
Release 6.4.0 - Add verification attempt-assets endpoints and card scheduled_activation_date (#382)
This release introduces several enhancements and structural improvements to the identity verification and face authentication modules. The main updates include adding support for pagination when listing verification attempts, introducing new fields and types for richer applicant data, and enabling retrieval of document/image assets for verification attempts. The changes also improve type annotations and documentation for better clarity and extensibility.
Pagination and Asset Retrieval Enhancements:
skip and limit) when listing verification attempts in the get...Attempts methods for identity, ID document, address document, and face authentication clients, using the new AttemptsQueryFilter class. These methods now use the new query method in ApiClient to handle query parameters. [1] [2] [3] [4] [5] [6]Applicant Data Model Improvements:
PhoneNumber, IdvAddress, IdentityDeclaredData, and IdentityVerificationClientInformation to capture richer applicant details, including phone, email, address, document issuing country, and document type. [1] [2] [3] [4]Type and Documentation Improvements:
ClientInformation, DeclaredData, and related request/response objects, specifying formats, examples, and optionality for better developer experience and validation. [1] [2]Dependency and Import Updates:
These updates make the API more flexible, extensible, and user-friendly, especially for clients needing to paginate results or capture additional applicant information.
| Kind | Change |
|---|---|
| removed | $activation_date -> $scheduled_activation_date on CardRequest and UpdateCardRequest |
<p style="white-space: pre-wrap; margin-top: 0.1em; margin-bottom: 0.2em; unicode-bidi: plaintext; color: rgb(204, 204, 204); font-family: -apple-system, "system-ui", "Segoe UI", Roboto, sans-serif; font-size: 13px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(24, 24, 24); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;">Note: nothing else is breaking. The new <code style="font-family: monospace; color: rgb(208, 208, 208); background: none 0% 0% / auto repeat scroll padding-box border-box rgb(60, 60, 60); padding: 2px 4px; border-radius: 3px; word-break: break-word; font-size: 0.9em;">getXAttempts($id, ?AttemptsQueryFilter $query = null)</code> and <code style="font-family: monospace; color: rgb(208, 208, 208); background: none 0% 0% / auto repeat scroll padding-box border-box rgb(60, 60, 60); padding: 2px 4px; border-radius: 3px; word-break: break-word; font-size: 0.9em;">updateCardDetails($cardId, $request, ?CardUpdateHeaders $headers = null)</code> parameters default to null, and <code style="font-family: monospace; color: rgb(208, 208, 208); background: none 0% 0% / auto repeat scroll padding-box border-box rgb(60, 60, 60); padding: 2px 4px; border-radius: 3px; word-break: break-word; font-size: 0.9em;">ApiClient::query()</code> was widened to accept a nullable filter. Properties are untyped, so the <code style="font-family: monospace; color: rgb(208, 208, 208); background: none 0% 0% / auto repeat scroll padding-box border-box rgb(60, 60, 60); padding: 2px 4px; border-radius: 3px; word-break: break-word; font-size: 0.9em;">IdentityDeclaredData</code> and <code style="font-family: monospace; color: rgb(208, 208, 208); background: none 0% 0% / auto repeat scroll padding-box border-box rgb(60, 60, 60); padding: 2px 4px; border-radius: 3px; word-break: break-word; font-size: 0.9em;">IdentityVerificationClientInformation</code> subclasses are a docblock change only.</p>
Add PaymentSetup accommodation/airline fields (total_number_of_guests, refundable, delivery_recipient, host, total_number_of_passengers, travel_type,
Release 6.3.0 (#379)
This release updates the OAuthScope class to align with the latest API specification, removing deprecated scopes, adding new ones, and ensuring accura…
Release 6.2.1 (#377)
This release updates the OAuthScope class to align with the latest API specification, removing deprecated scopes, adding new ones, and ensuring accuracy and maintainability. It also updates related integration tests to use the correct scopes and introduces a comprehensive unit test suite for OAuthScope.
OAuthScope class updates:
issuing:card-mgmt and issuing:client, as well as marketplace, and replaced them with the appropriate card-management scopes. Added new scopes: compliance-requests, flow:reflow, issuing-disputes, and vault:tokens-metadata. Properties are now consistently ordered alphabetically, and documentation was improved. [1] [2] [3] [4]Test updates:
AbstractIssuingIntegrationTest.php, TransactionsIntegrationTest.php, and SandboxTestFixture.php) to use the new card-management scope properties instead of the retired ones, with clarifying comments. [1] [2] [3]New unit tests for OAuthScope:
OAuthScopeTest.php to verify that all documented scopes are present, that no wire value is blank or duplicated, and that properties are declared in alphabetical order. Also includes tests to distinguish similar-looking scopes and to check for spec sync correctness.This release introduces several enhancements and fixes to the balances and payments functionality, focusing on improved support for sub-account (curre
Release 6.2.0 (#375)
This release introduces several enhancements and fixes to the balances and payments functionality, focusing on improved support for sub-account (currency account) operations, more robust query parameter handling, and expanded test coverage. Key changes include the addition of a new endpoint for retrieving top-up instructions, improvements to query parameter serialization, and new/updated tests to ensure correct API contract adherence.
Balances and Currency Account Enhancements:
retrieveTopUpInstructions method to BalancesClient, allowing retrieval of bank details and payment reference information required to top up a sub-account (currency account). This includes comprehensive documentation of the response structure. (lib/Checkout/Balances/BalancesClient.php) [1] [2]balances:top-up-instructions OAuth scope to support authorization for the new endpoint. (lib/Checkout/OAuthScope.php)Query Parameter Serialization Improvements:
AbstractQueryFilter::getEncodedQueryParameters() to only include set parameters, avoid trailing ampersands, and serialize booleans as "true"/"false" (not 1/0) to comply with API requirements. (lib/Checkout/Common/AbstractQueryFilter.php)BalancesQuery to support withCurrencyAccountId (boolean) and balancesAt (datetime) parameters, with detailed documentation on naming and expected wire format. (lib/Checkout/Balances/BalancesQuery.php)Payments API Schema Update:
amount_allocations property to PaymentSessionSubmitRequest, supporting allocation of payment amounts to sub-entities, with min/max constraints and documentation. (lib/Checkout/Payments/Sessions/PaymentSessionSubmitRequest.php)Test Coverage and Validation:
BalancesQuery parameters, ensuring camelCase keys and correct boolean/date formatting. (test/Checkout/Tests/Balances/BalancesQuerySerializationTest.php)retrieveTopUpInstructions endpoint, including both mocked and integration tests that handle expected API error responses gracefully. (test/Checkout/Tests/Balances/BalancesClientTest.php, test/Checkout/Tests/Balances/BalancesIntegrationTest.php) [1] [2] [3] [4]amount_allocations in payment session requests. (test/Checkout/Tests/Payments/Sessions/PaymentSessionSubmitRequestSerializationTest.php)balances:top-up-instructions permission. (test/Checkout/Tests/SandboxTestFixture.php)These changes improve the SDK's compliance with the latest API specifications, enhance developer usability, and strengthen contract validation through comprehensive testing.
This release introduces comprehensive support for Bacs and ACH Direct Debit instruments in the SDK, including new client classes, request models, and
Release 6.1.0 (#372)
This release introduces comprehensive support for Bacs and ACH Direct Debit instruments in the SDK, including new client classes, request models, and type definitions. It also updates core enums to recognize these new instrument and payment source types. The changes enable storing, configuring, and sending notifications for Bacs and ACH instruments, and ensure the SDK aligns with the latest API specifications.
Bacs Direct Debit Support:
BacsClient for sending Bacs Direct Debit pre-notifications, with corresponding request and notification type classes (BacsNotificationRequest, BacsNotificationType). Also exposed getBacsClient() in CheckoutApi. [1] [2] [3] [4] [5] [6] [7]CreateBacsInstrumentRequest, CreateBacsInstrumentAccount, CreateBacsInstrumentData, CreateBacsAccountHolder, CreateBacsBillingAddress, and BacsPaymentType. [1] [2] [3] [4] [5] [6]ACH Direct Debit Support:
CreateAchInstrumentRequest, CreateAchInstrumentData, CreateAchAccountHolder, and AchAccountType. [1] [2] [3] [4]SEPA Direct Debit Support:
CreateSepaAccountHolder for SEPA instrument account holder details.Core Enum Updates:
InstrumentType and PaymentSourceType to include bacs and ach as valid types, reflecting new instrument and payment source options. [1] [2] [3] [4]These changes provide the necessary models and client interfaces to support Bacs and ACH Direct Debit instruments, improve maintainability, and ensure compatibility with the current API.
This release is breaking and ships as 6.0.0 (already bumped in this branch via the merged
Release 6.0.0 (#370) commit: CheckoutUtils::PROJECT_VERSION and version.json).
The instruments models were reshaped so that each scheme (SEPA, Bacs, ACH) and each operation
(store, update) has its own type. Previously a single InstrumentData and the shared
Checkout\Common\AccountHolder were reused across operations they did not match, which exposed
fields the API rejects and hid fields it requires.
| Removed | Replacement |
|---|---|
Checkout\Instruments\Create\InstrumentData |
Checkout\Instruments\Create\CreateSepaInstrumentData (store) / Checkout\Instruments\Update\UpdateSepaInstrumentData (update) |
The removed class held account_number, country, currency, payment_type, mandate_id and
date_of_signature. All six exist on the replacements, plus type (the SEPA mandate type), which
the specification declares and the old class was missing.
All three are on Checkout\Instruments\Create\CreateSepaInstrumentRequest:
| Property | Before | After |
|---|---|---|
$instrument_data |
Checkout\Instruments\Create\InstrumentData |
CreateSepaInstrumentData |
$account_holder |
Checkout\Common\AccountHolder (15 properties) |
CreateSepaAccountHolder (5 properties) |
$customer |
\Checkout\Instruments\Create\UpdateCustomerRequest |
CreateCustomerInstrumentRequest |
The $customer entry is a documentation correction rather than a runtime change: the old @var
pointed at a class that does not exist in that namespace (the real one lives in
Checkout\Instruments\Update). Static analysis will now flag callers who pass the old type.
// Before
$instrumentData = new InstrumentData();
$instrumentData->account_number = "FR7630006000011234567890189";
$instrumentData->country = Country::$FR;
$instrumentData->currency = Currency::$EUR;
$instrumentData->payment_type = PaymentType::$recurring; // sent "Recurring" - rejected
$accountHolder = new AccountHolder();
$accountHolder->first_name = "John";
$accountHolder->last_name = "Wick";
$accountHolder->phone = $phone; // not in the SEPA schema
$accountHolder->billing_address = $address;
$request = new CreateSepaInstrumentRequest();
$request->instrument_data = $instrumentData;
$request->account_holder = $accountHolder;
// After
$instrumentData = new CreateSepaInstrumentData();
$instrumentData->type = SepaMandateType::$core; // new: was missing entirely
$instrumentData->account_number = "FR7630006000011234567890189";
$instrumentData->country = Country::$FR;
$instrumentData->currency = Currency::$EUR;
$instrumentData->payment_type = SepaPaymentType::$recurring; // sends "recurring"
$billingAddress = new CreateSepaBillingAddress();
$billingAddress->address_line1 = "Evergreen Terrace";
$billingAddress->address_line2 = "742";
$billingAddress->city = "Paris";
$billingAddress->zip = "75000";
$billingAddress->country = Country::$FR;
$accountHolder = new CreateSepaAccountHolder();
$accountHolder->first_name = "John";
$accountHolder->last_name = "Wick";
$accountHolder->billing_address = $billingAddress;
$request = new CreateSepaInstrumentRequest();
$request->instrument_data = $instrumentData;
$request->account_holder = $accountHolder;
The merchant-specific subdomain (environmentSubdomain) is now required. Set it, or call the deprecated useLegacyDomain() to keep using the shared chec…
Release 6.0.0 (#370)
Add InstrumentDocumentType with bank_statement for bank account payment instrument documents
Release 5.4.0 (#364)
…are added to verify correct serialization and deprecation handling.
Release 5.3.0 (#358)
This pull request introduces several improvements and clarifications to the 3DS challenge indicator and related enums used in session and payment APIs. The main focus is on separating the values specific to session requests from those used in payment flows, improving documentation, and ensuring backwards compatibility. Additionally, related enums are updated for clarity and consistency, and comprehensive tests are added to verify correct serialization and deprecation handling.
Key changes:
SessionChallengeIndicatorType class with clear documentation and nine explicit values, including exemption values, for use only with session requests (POST /sessions). This separates session-specific values from those used in payments.ChallengeIndicatorType in Checkout\Common to clarify that five exemption values are deprecated and only accepted by sessions, not by payments or hosted payments. Documentation is improved and deprecation tags are added for these values.SessionRequest to use SessionChallengeIndicatorType for the challenge_indicator property, with improved docblocks and default value assignment. [1] [2] [3]Category, SessionScheme, and TransactionType enums with improved documentation, consistent naming, and added or corrected values (e.g., non_payment, quasi_card_transaction, new schemes like discover and upi). [1] [2] [3]ChallengeIndicatorSerializationTest, to verify that all challenge indicator values are exposed, correctly serialized, and properly marked as deprecated where appropriate.SessionChallengeIndicatorType for session requests. [1] [2] [3] [4] [5]These changes clarify the intended usage of challenge indicator values, improve maintainability, and ensure that the SDK aligns with API expectations and best practices.
This release adds missing fields to the RepresentativeIndividual model for the Accounts API v3.0 and updates the forward secrets endpoint path.
Release 5.2.1 (#355)
This release adds missing fields to the RepresentativeIndividual model for the Accounts API v3.0 and updates the forward secrets endpoint path.
Accounts API v3.0 Model Additions and Updates:
Citizenship class and extended RepresentativeIndividual with the citizenships array and national_id_type fields.NationalIdType enum covering the various types of national identification numbers.FinancialStatements class and FinancialStatementsType enum, and updated OnboardSubEntityDocuments to use FinancialStatements for the financial_statements field.Forward API:
/secrets/{name} (INT-1666).Accounts API v3.0 Schema Versioning Support: BREAKING CHANGE!
Release 5.2.0 (#352)
** Accounts BREAKING CHANGE **
This release introduces significant enhancements and extensions to the Accounts API client and related data models to support Accounts API v3.0. The main goals are to enable schema version negotiation via the Accept header, expand the onboarding request and company models for new v3.0 fields, and add several new supporting classes for richer onboarding flows.
The most important changes are:
Accounts API v3.0 Schema Versioning Support: BREAKING CHANGE!
DEFAULT_SCHEMA_VERSION constant and updated key client methods in AccountsClient to accept a $schemaVersion parameter (defaulting to 3.0), passing this as an Accept header to the API. This enables negotiation of the Accounts API schema version for all major entity operations. [1] [2] [3] [4] [5]Expanded Onboarding and Company Models:
OnboardEntityRequest and Company with new fields required by Accounts API v3.0, such as processing_details, agreed_terms, seller_category, is_draft, date_of_incorporation, regulatory_licence_number, and more. Added detailed PHPDoc for each field. [1] [2]BusinessType and new entity roles in EntityRoles for v3.0 compatibility. [1] [2]New Supporting Data Classes for v3.0:
AgreedTerms, ProcessingDetails, ProcessingDetailsPayments, ProcessingDetailsAch, DateOfIncorporation, and CompanyPosition. These enable capturing additional information required by the latest API version. [1] [2] [3] [4] [5] [6]OnboardSubEntityDocuments Enhancements:
OnboardSubEntityDocuments with new optional document fields (e.g., articles_of_association, shareholder_structure, bank_verification, etc.) to support the full set of required documents for different onboarding schema variants.Documentation and Header Handling Improvements:
Headers to support the new accept header for schema negotiation.These changes collectively prepare the codebase for full support of Accounts API v3.0 onboarding and entity management, while maintaining backward compatibility.
…order/payment setup models. It also removes some deprecated or redundant classes and fields to streamline the codebase.
Release 5.1.0 (#347)
This release introduces several new features and improvements to the issuing and payments domains, including expanded support for dispute handling, enhancements to card activation and revocation scheduling, and richer order/payment setup models. It also removes some deprecated or redundant classes and fields to streamline the codebase.
Issuing Disputes Enhancements:
IssuingDisputeFraudDetails, IssuingDisputeFraudType) and integrated them into dispute request classes, allowing for more granular and structured fraud reporting. [1] [2] [3] [4] [5] [6]AmendDisputeRequest model and corresponding amendDispute method in IssuingClient, enabling amendments to disputes that are blocked or require additional information. [1] [2] [3] [4]submitDispute method as deprecated, guiding users towards the new dispute amendment flow.Card Management Improvements:
activation_date and revocation_date fields to both CardRequest and UpdateCardRequest classes, allowing for scheduled card activation and automatic revocation. [1] [2]ScheduleRevocationRequest class and related scheduling methods from IssuingClient, consolidating revocation scheduling into the main card request models. [1] [2] [3]Payments and Order Setup Extensions:
Order model with new fields for invoice_id, shipping_amount, surcharge_amount, tax_amount, tipping_amount, and amount_allocations, supporting more detailed order breakdowns.PaymentSetupAmountAllocation and AmountAllocationCommission, enabling split payments and commission handling in setup flows. [1] [2]PaymentSetupBillingDescriptor model for richer payment descriptions and billing information.Account and Instrument Details:
InstrumentAccountType and InstrumentDetailsAch models to support ACH payment instrument details, including account and routing numbers. [1] [2]Cleanup and Deprecations:
CardholderDocument class and related references from cardholder request models, simplifying cardholder data structures. [1] [2] [3] [4]These changes collectively improve the flexibility, compliance, and functionality of the issuing and payments APIs, while also streamlining the codebase for easier maintenance.…nd Platforms instrument details)
GetFaceAuthenticationAttemptAssets, PaymentPlan updates + Move to PHP versions 8.X (dropped all 7.X ones)
GetFaceAuthenticationAttemptAssets, PaymentPlan updates + Move to PHP versions 8.X (dropped all 7.X ones) (#345)
BREAKING CHANGE
This release drops support for PHP 7.1 and 7.4, raising the minimum required PHP version to 8.1. It updates the SDK and its dependencies accordingly, simplifies the Composer and CI workflows, and updates documentation to reflect these changes.
PHP version and dependency requirements:
composer.json to require php: >=8.1.0, guzzlehttp/guzzle: ^7.4, and monolog/monolog: ^2.4 || ^3.0.0; dropped support for older versions and removed compatibility with PHP 7.x and Guzzle 6.x. Updated dev dependencies to require phpunit/phpunit: ^9.0 only.README.md to state that as of v5.0.0, the SDK requires PHP 8.1 or newer, and to explain the rationale for dropping PHP 7.x support. Updated Composer example accordingly.Continuous Integration (CI) and workflow changes:
build-master.yml, build-pull-request.yml, build-release.yml), so CI now only tests PHP 8.1 and 8.4 on supported OSes. Simplified installation and Composer steps accordingly. [1] [2] [3] [4] [5] [6] [7] [8]General update
This release introduces new functionality for retrieving assets associated with face authentication and identity verification attempts, adds support for recurring payment plans and authorization types to several payment request objects, and exposes a new processing field. It also includes comprehensive tests for the new features.
Identity Verification & Face Authentication Enhancements:
AttemptAssetsQueryFilter entity to support pagination when querying assets related to authentication and verification attempts.getFaceAuthenticationAttemptAssets and getIdentityVerificationAttemptAssets methods in their respective clients, enabling retrieval of assets (like images and videos) captured during an attempt, with optional pagination. [1] [2]Payments API Improvements:
payment_plan and authorization_type fields to HostedPaymentsSessionRequest, PaymentLinkRequest, and PaymentSessionsRequest. [1] [2] [3]scheme_transaction_link_id field in ProcessingSettings to allow access to the scheme transaction link identifier for card transactions.scheme_transaction_link_id field, confirming its presence and type when available.Release 4.9.0 - General payments update
Release 4.9.0 - General payments update (#340)
This release introduces several new features and enhancements across the SDK, mainly focusing on expanding support for dispute evidence, onboarding simulation, and entity requirements, along with some smaller improvements and bug fixes. The most important changes are grouped below by theme.
Onboarding Simulator Support:
OnboardingSimulatorClient class and related request objects, enabling sandbox testing of account onboarding workflows, such as setting requirements due, running scenarios, and updating entity status. This client is now accessible via the main CheckoutApi class. [1] [2] [3] [4] [5] [6] [7]Entity Requirements Management:
AccountsClient with methods to retrieve pending requirements for a sub-entity, get details about specific requirements, and resolve requirements with a new EntityRequirementUpdateRequest class. [1] [2] [3]Dispute Evidence Enhancements:
CompellingEvidence model and extended the DisputeEvidenceRequest to support new fields for arbitration evidence and compelling evidence, improving dispute handling capabilities. [1] [2] [3]Instruments Management Improvements:
revoke method to InstrumentsClient to allow revoking instruments for future transactions, and updated related request classes for clarity and expanded customer data support. [1] [2] [3] [4] [5]Other Enhancements and Fixes:
DestinationRequest for forwarding requests.These changes collectively improve the SDK's feature coverage, especially for testing onboarding flows, managing entity compliance, and dispute resolution.
This release adds support for a wide range of new alternative payment methods (APMs) by introducing new payment source types and corresponding request
Release 4.8.0 (#337)
This release adds support for a wide range of new alternative payment methods (APMs) by introducing new payment source types and corresponding request source classes. These changes enable the system to handle additional payment options such as ACH, Bizum, Blik, MobilePay, Octopus, PayNow, Plaid, Sequra, Swish, Twint, and Vipps, among others. The update primarily involves extending the PaymentSourceType enumeration and implementing new request classes for each APM, some of which include additional relevant fields.
Support for new payment source types:
PaymentSourceType for various APMs, including bizum, ach, blik, mobilepay, octopus, paynow, plaid, sequra, swish, twint, and vipps.New request source classes for APMs:
Apm namespace for each supported APM:
Additional fields for specific payment sources:
account_type, country, account_number for ACH, partner_agreement_id for Blik, token and account_holder for Plaid, billing_address for Sequra, and billing_descriptor for Swish. [1] [2] [3] [4] [5]These changes collectively expand the system's capability to support a broader array of payment methods, improving flexibility and coverage for international payments.
This release updates the naming conventions for request class properties in the Google Pay integration to use snake_case instead of camelCase. This ch
Version 4.7.1 (#332)
This release updates the naming conventions for request class properties in the Google Pay integration to use snake_case instead of camelCase. This change improves consistency and aligns with common PHP coding standards.
Property renaming for consistency:
Renamed properties in GooglePayEnrollmentRequest from camelCase to snake_case: entityId → entity_id, emailAddress → email_address, and acceptTermsOfService → accept_terms_of_service.
Renamed the webDomain property to web_domain in GooglePayRegisterDomainRequest.…snake-case)
This release adds support for new sdk clients: Agentic Commerce, Compliance Requests and GooglePay. It introduces new API clients, request/response en
Release - 4.7.0 (#330)
This release adds support for new sdk clients: Agentic Commerce, Compliance Requests and GooglePay. It introduces new API clients, request/response entity classes, and updates the main CheckoutApi class to expose these clients. Additionally, it updates the API client to allow passing custom headers for POST requests. These changes enable delegated payment token creation, compliance request retrieval, and response submission.
Agentic Commerce API integration:
AgenticCommerceClient for creating delegated payment tokens, including support for custom integrity headers and idempotency keys.DelegatedPaymentRequest, DelegatedPaymentAllowance, DelegatedPaymentBillingAddress, DelegatedPaymentMethodCard, DelegatedPaymentRiskSignal, and supporting enums/types for card and funding types. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]Compliance Requests API integration:
ComplianceRequestsClient to retrieve and respond to compliance requests by payment ID.ComplianceRespondedField, ComplianceRespondedFields. [1] [2]Google Pay API integration:
GooglePayClient to manage all google pay enrollments and domainsCore API enhancements:
ApiClient::post to accept optional custom headers, supporting new API requirements for integrity and versioning.Main API surface changes:
Added account_name_inquiry field to AccountHolder class
Release - 4.6.1 (#328)
Added account_name_inquiry field to AccountHolder class (#327)
This release introduces a small update to the AccountHolder class by adding a new property to support account name inquiry functionality.
lib/Checkout/Common/AccountHolder.php: Added a new public boolean property account_name_inquiry to the AccountHolder class to indicate whether an account name inquiry has been performed.
This release introduces several enhancements and new features to the SDK, focusing on expanding API coverage, improving file handling. The changes inc
Release - 4.6.0 (#311)
This release introduces several enhancements and new features to the SDK, focusing on expanding API coverage, improving file handling. The changes include new client methods for file upload and retrieval, support for additional API clients, improvements to request serialization, and the addition of several new data classes.
Major SDK Feature Additions and Improvements:
AccountsClient for uploading and retrieving files for sub-entities, supporting due diligence documentation.DisputesClient to support arbitration evidence submission and retrieval for disputes.FilePurpose (for file upload purposes), UploadFileRequest (file upload request model), CardholderAccessTokenRequest, UpdateCardholderRequest, and CardMetadata. [1] [2] [3] [4] [5]ShippingInstructions in the issuing cards module to clarify and swap the meaning of shipping_address and recipient_address.API Client and Serialization Enhancements:
ApiClient to correctly set content types for JSON, multipart, and form-urlencoded requests, ensuring more robust API interactions.Client to serialize request objects as form-urlencoded data, converting camelCase properties to snake_case as required by some endpoints.Expanded API Client Access:
CheckoutApi: PaymentMethodsClient, StandaloneAccountUpdaterClient, and ApplePayClient, with corresponding getter methods for easier access. [1] [2] [3] [4]Other Minor Improvements:
UploadFileRequest in AccountsClient to support the new file upload feature.DisputesClient.This release introduces new features and enhancements to the Checkout API client, focusing on expanding support for identities management, sub-entity
Release - 4.5.0 (#309)
This release introduces new features and enhancements to the Checkout API client, focusing on expanding support for identities management, sub-entity member management, reserve rules, and additional API clients. It also improves the flexibility of the API client for handling custom headers and request body formats. Below are the most important changes:
Refactored ApiClient to support custom headers via reflection, improved handling of different request body formats (JSON, multipart form data, form URL encoded), and updated method signatures for greater flexibility. [1] [2] [3] [4] [5]
Refactored ApiClient methods to accept a more generic $requestBody and optional custom headers, improving support for different content types (JSON, multipart, form URL encoded) and making header injection more flexible via reflection. Utility methods were added for header conversion and content-type detection. [1] [2] [3] [4] [5]
New if-match header support in the put requests through Accounts Headers class.
CheckoutApi for NetworkTokensClient, FaceAuthenticationClient, IdDocumentVerificationClient, IdentityVerificationClient, AmlScreeningClient, and ApplicantsClient, enabling access to additional Checkout.com API features. [1] [2] [3] [4] [5] [6]AccountsClient for managing sub-entity members (retrieving and reinviting) and reserve rules (creating, retrieving, updating, and fetching details). New request and entity classes for reserve rules (CreateReserveRuleRequest, UpdateReserveRuleRequest, Rolling, HoldingDuration) were introduced. [1] [2] [3] [4] [5]AccountsClient to manage sub-entity members (retrieving and re-inviting members) and reserve rules (creating, querying, retrieving details, and updating reserve rules), along with the necessary request and entity classes (CreateReserveRuleRequest, UpdateReserveRuleRequest, Rolling, HoldingDuration). [1] [2] [3] [4] [5] [6] [7]FaceAuthenticationClient, IdDocumentVerificationClient, IdentityVerificationClient, AmlScreeningClient, ApplicantsClient) into CheckoutApi, with corresponding getter methods for each. [1] [2] [3] [4]Moved and renamed files in the Forward module from the Requests namespace to the Entities namespace for improved clarity and consistency. (Headers.php, MethodType.php, NetworkToken.php) [1] [2] [3]This pull request introduces several new features and improvements to the Checkout SDK, focusing on enhanced support for sub-entity management, reserve rules, and identity verification, as well as improvements to the API client for more flexible request handling. It also includes some refactoring and namespace changes for better organization.
Refactored several ForwardClient request-related classes to reside under the Entities namespace instead of Requests, improving code organization and clarity. [1] [2] [3] [4] [5] [6]
These changes collectively add significant new functionality for managing sub-entity users and reserve rules, improve the flexibility of API requests, and enhance the SDK's support for identity verification workflows.
feat: update Hosted Payments Request with missing fields
Release 4.4.1 (#306)
Enhance JsonSerializer to prevent escaping forward slashes in Google Pay signedMessage
Release 4.4.0 (#304)
Release 4.3.2 - security hardening
Release 4.3.2 - security hardening (#420)
This release brings security hardening and input validation for request URLs. Please check the behaviour changes before upgrading.
Release 4.3.1 - security hardening
Release 4.3.1 - security hardening (#412)
This release brings security hardening and raises dependency minimums. Please check the new requirements before upgrading.
composer update checkout/checkout-sdk-php guzzlehttp/guzzle -W
to get Guzzle 7.15.2 or laterFix file upload Content-Length for Dispute API
Release 4.3.0 (#302)
Release 4.2.0 - Merchant-specific DNS names support for access
Release 4.2.0 - Merchant-specific DNS names support for access (#300)
Release 4.1.0 - New endpoint payments setups support
Release 4.1.0 - New endpoint payments setups support (#298)
This release introduces significant new functionality to support payment setups in the Checkout API, including the addition of new client classes, data models, and enhancements to existing payment and industry data structures. The main focus is on expanding the API's support for more complex payment setup scenarios, such as customer details, industry-specific data, and a variety of payment methods.
feat: add affiliate_id and affiliate_url to ProcessingSettings, type and sub_type to Product, and create ProductSubType class
Release 4.0.3 (#295)
changed build-release Read release version task with a bash script
Release/4.0.2 (#293)
feat: adds Dlocal signature support with parameters for API integration
Release 4.0.0 (#288)
feat: updates device properties with detailed descriptions and optional
Release 3.3.0 (#284)
Release 3.2.10 - security hardening
Release 3.2.10 - security hardening (#419)
This release brings security hardening and input validation for request URLs. Please check the behaviour changes before upgrading.
Release 3.2.9 - security hardening
Release 3.2.9 - security hardening (#413)
This release brings security hardening and raises dependency minimums. Please check the new requirements before upgrading.
composer update checkout/checkout-sdk-php guzzlehttp/guzzle -W
to get Guzzle 7.15.2 or laterfeat: Adds New Property and Update Test Cases for Payment Processing
Release 3.2.8 (#280)
Adds authentication for payment request by @JZds
Release 3.2.7 (#275)
Release 3.2.6 (#272) * Fix Payment Session Request
Release 3.2.6 (#272)
Updates Workflow properties and endpoints
Release 3.2.5 (#270)
Updates DNS Merchant regular expression length
Release 3.2.4 (#268)
Updates payment sessions schemas
Release 3.2.3 (#265)
Adds partial authorization in payment request
Release 3.2.2 (#261)
Adds destination object inside refund payment request
Release 3.2.1 (#259)
Adds SEPA Direct Debit Core Support
Release 3.2.0 (#253)
Adds new field challenge_notification_url to the completion object
Release 3.1.0 (#246)
Update payment request for payment contexts
Release 3.0.21 (#235)
payment sessions supportpayment request for payment contextsgiropay sourceAdds custom guzzle client configuration support
Release 3.0.20 (#232)
Adds request and get payment contexts endpoints
Release 3.0.19 (#230)
payment contexts endpointsUpdate capture payment request param to optional
Release 3.0.18 (#227)
Update GitHub Actions yaml files
Release 3.0.17
Adds funds_transfer_type in instruction inside payments
Release 3.0.15
Update readme file and Remove Sonar Cloud
Release 3.0.14
Adds support for Cardholders operations [Issuing] (CS2)
Release 3.0.13
Cardholders operations [Issuing] (CS2)Cards operations [Issuing] (CS2)Card Controls operations [Issuing] (CS2)Card Testing operations [Issuing] (CS2)SimulateIncrement for Card Testing [Issuing] (CS2)SimulateClearing for Card Testing [Issuing] (CS2)SimulateReversal for Card Testing [Issuing] (CS2)Adds card_token object to PaymentInstrumentRequest for Integrated Platforms (CS2)
Release 3.0.12
card_token object to PaymentInstrumentRequest for Integrated Platforms (CS2)if-match header to UpdatePaymentInstrumentRequest for Integrated Platforms (CS2)TransactionCurrencyAmount in Financial Actions (CS2)Add Reports API redirect support
Release 3.0.11
One column per quarter.