3.13.0

Release 3.13.0 (#228)

• Add InstrumentDocumentType with bank_statement for bank account payment instrument documents (#227)

3.12.0

Release 3.12.0

Release 3.12.0 bundles two changes: the new Address Document Verification endpoints (#223, INT-1665) and the sessions enum alignment with the API spec (#224, INT-1667).

Address Document Verification (Adv) endpoints

Implements the Adv family from swagger 2026-07-16: POST/GET /address-document-verifications, anonymize, attempts (create, list, get) and pdf-report. Reuses the identity-verification scope.

• New AddressDocumentVerificationClient with 7 methods. (checkout_sdk/identities/addressdocumentverification/addressdocumentverification_client.py)
• New AddressDocumentVerificationRequest and AddressDocumentVerificationAttemptRequest models. (checkout_sdk/identities/addressdocumentverification/addressdocumentverification.py)
• Exposed on CheckoutApi via the identity API client. (checkout_sdk/checkout_api.py)
• Client tests under tests/identities/addressdocumentverification/.

Enum and API spec alignment for sessions

• Updated the SessionChallengeIndicator and ChallengeIndicator enums to clearly document and enforce their distinct value sets, separating the exemption values for /sessions from the four-value set used in payments endpoints. (checkout_sdk/common/enums.py, checkout_sdk/sessions/sessions.py)
• Corrected the ThreeDsMethodCompletion enum to use uppercase values ('Y', 'N', 'U') as required by the API.
• Expanded the SessionScheme enum with the missing 'discover' and 'upi' values.
• Replaced the incorrect single-value ShippingIndicator enum with all seven spec-compliant values, making MerchantRiskInfo.shipping_indicator usable.

Test coverage and guardrails

• tests/sessions/challenge_indicator_serialization_test.py verifies the enums expose the correct values, serialize as expected, and that exemption values are not accepted where unsupported.
• tests/sessions/session_request_serialization_test.py ensures all SessionRequest attributes serialize correctly, including defaults and nested objects.
• tests/sessions/sessions_enums_test.py systematically checks that all session enums match the API spec, with the correct casing and full value coverage.

3.11.0

Release 3.11.0 (#222)

This release introduces significant enhancements to the Accounts API SDK, primarily to support schema version negotiation (notably v3.0), and to expand the data model for onboarding entities. The changes include new and extended models, improved header management for schema versioning, and comprehensive tests for both v2.0 and v3.0 onboarding flows.

Schema Versioning and API Client Updates:

• Added support for schema version negotiation via the Accept header, defaulting to version 3.0, with the ability to override per request. The client methods (create_entity, get_entity, update_entity, get_entity_requirements) now accept a schema_version parameter and automatically set the appropriate header (SchemaVersionHeader). ([[1]](diffhunk://#diff-04b8068d21fa4f9631448ea1382f23a46415c6c91ac69592aab21ffbaa9e1956R17-R18), [[2]](diffhunk://#diff-04b8068d21fa4f9631448ea1382f23a46415c6c91ac69592aab21ffbaa9e1956R39-R58), [[3]](diffhunk://#diff-04b8068d21fa4f9631448ea1382f23a46415c6c91ac69592aab21ffbaa9e1956L57-R79), [[4]](diffhunk://#diff-04b8068d21fa4f9631448ea1382f23a46415c6c91ac69592aab21ffbaa9e1956L152-R169))
• Updated the core ApiClient to forward custom headers in all HTTP methods. ([checkout_sdk/api_client.pyL39-R41](diffhunk://#diff-acf0ad95c1619c734caa40dcaf7e9cf88c02fed38af0661b6914f0c50d97c239L39-R41))

Data Model Extensions for v3.0:

• Expanded the BusinessType, EntityRoles, and added new enums (CompanyPosition, NationalIdType) to support a broader range of business and individual classifications. ([checkout_sdk/accounts/accounts.pyR26-R76](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15R26-R76))
• Introduced new models for documents and entity details: ArticlesOfAssociation, FinancialStatements, Citizenship, RepresentativeIndividual, and extended EntityRepresentative to support v3.0 nested structures. ([[1]](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15R150-R154), [[2]](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15R204-R216), [[3]](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15R226-R256), [[4]](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15L184-L185))
• Enhanced company and processing details with new fields such as additional_trading_names, is_registered_company, and detailed payment/ACH processing breakdowns. ([[1]](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15R291-R292), [[2]](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15R320-R339))
• Added models for terms agreement (AgreedTerms) and schema version headers. ([checkout_sdk/accounts/accounts.pyR348-R377](diffhunk://#diff-1f64ad373700ab92add57f71f3ebef70572dc4e464938486ab8ba171e71f4b15R348-R377))

Testing Improvements:

• Added unit tests to verify that the correct schema version is set in the Accept header for all relevant client methods, including override scenarios. ([tests/accounts/accounts_client_test.pyR171-R206](diffhunk://#diff-db2dff7a33193a6d36054912055383ed84b396da4ae0eaa5a5f52d3b6043626eR171-R206))
• Updated integration tests to explicitly test both v2.0 and v3.0 onboarding flows, including new v3.0 company onboarding with nested representatives and expanded data fields. ([[1]](diffhunk://#diff-da8211ceb59f250b13f856bc34846f9460b36a34da61864b490e83df24bd8ee1L54-R62), [[2]](diffhunk://#diff-da8211ceb59f250b13f856bc34846f9460b36a34da61864b490e83df24bd8ee1L75-R159))

Codebase Maintenance:

• Updated imports and refactored test setup to accommodate new models and enums. ([tests/accounts/accounts_integration_test.pyL12-R15](diffhunk://#diff-da8211ceb59f250b13f856bc34846f9460b36a34da61864b490e83df24bd8ee1L12-R15))

These changes collectively enable the SDK to support the latest Accounts API features, improve flexibility for future schema versions, and ensure robust onboarding flows for both individual and company entities.

References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]…ault now 3.0

3.10.0

Release 3.10.0 (#219)

• Align SDK with 2026-06-29 API changes (Issuing, Payment Setups, Platforms ACH) (#218)
• feat: add authorization_type and payment_plan to payment request classes (#213)

3.9.1

Release 3.9.1 (#217)

This release the Product model to use strongly-typed enums for the type and sub_type fields and ensures that these enums serialize to lowercase strings, improving consistency and type safety. It also introduces a comprehensive test suite to verify correct serialization behavior, including handling of None values.

Model and Enum Refactoring

• Introduced a new ItemType enum and updated the Product class to use ItemType and ProductSubType enums for the type and sub_type fields, respectively, instead of plain strings. The enums now serialize as lowercase values for consistency. (checkout_sdk/payments/payments.py, checkout_sdk/payments/payments.pyR627-R643)
• Updated the ProductSubType enum values to be lowercase, aligning with serialization expectations. (checkout_sdk/payments/payments.py, checkout_sdk/payments/payments.pyR627-R643)

Serialization and Testing

• Added a new test module product_serialization_test.py with tests to ensure that Product serializes type and sub_type fields as lowercase strings, supports None values, and round-trips all fields correctly. (tests/payments/product_serialization_test.py, tests/payments/product_serialization_test.pyR1-R99)

Typing Improvements

• Added Optional import from typing to support optional enum fields in the model. (checkout_sdk/payments/payments.py, checkout_sdk/payments/payments.pyR5)

3.9.0

Release - 3.9.0 - GetFaceAuthenticationAttemptAssets + PaymentPlan updates (#215)

This release introduces new functionality for retrieving assets associated with face authentication and identity verification attempts, adds support for payment plans and authorization types in payment-related requests, and makes minor enhancements to processing settings. It also includes corresponding unit and integration tests for the new API methods.

Identity Verification & Face Authentication Enhancements:

• Added a new AttemptAssetsQueryFilter class for paginating asset queries in checkout_sdk/identities/entities.py.
• Added get_face_authentication_attempt_assets and get_identity_verification_attempt_assets methods to their respective clients, enabling retrieval of assets for a given attempt with optional pagination. [1] [2]
• Updated tests to cover the new asset retrieval methods for both face authentication and identity verification, including integration and unit tests. [1] [2] [3] [4]

Payments API Improvements:

• Added payment_plan and authorization_type fields to HostedPaymentsSessionRequest, PaymentLinkRequest, and PaymentSessionsRequest classes, extending support for these features across payment flows. [1] [2] [3]
• Included PaymentPlan and AuthorizationType in relevant imports for payment modules. [1] [2] [3]

Processing Settings Update:

• Added a new scheme_transaction_link_id field to the ProcessingSettings class, allowing additional transaction metadata to be passed.

Other:

• Updated an OAuth integration test to check for a more descriptive error message on authentication failure.

3.8.0

Python payments update (#212)

This release introduces several new features and enhancements across the SDK, focusing on onboarding simulation, payment setup, account management, instrument operations, and token handling. The changes add new client classes, extend data models, and provide additional API methods to support advanced use cases and testing scenarios.

Onboarding Simulator Integration:

• Added a new OnboardingSimulatorClient with methods to simulate entity onboarding scenarios, set requirements due, set entity status, and list available requirements and scenarios. Supporting request/response models and enums were also introduced. [1] [2] [3] [4] [5]

Accounts and Entity Requirements:

• Added support for retrieving and resolving entity requirements in AccountsClient, including new methods for getting requirements, getting requirement details, and resolving requirements, along with the associated request model. Tests were added to cover these new methods. [1] [2] [3] [4] [5] [6]

Payment Setup and Instruments Enhancements:

• Extended payment setup models to support new payment methods (Blik, Paypal), detailed account funding transaction fields, and additional processing options. [1] [2] [3] [4] [5]
• Updated CreateCardInstrumentRequest to adjust the order and inclusion of fields.
• Added a revoke method to InstrumentsClient for revoking instruments, with corresponding test coverage. [1] [2]

Token Handling Improvements:

• Introduced new token types (CVV, PIN) with corresponding request and data models, and added a method to retrieve token metadata in TokensClient, with tests. [1] [2] [3] [4]

These changes collectively improve the SDK's support for onboarding simulation, entity management, payment method flexibility, and tokenization workflows.

3.7.0

Release 3.7.0 (#209)

This release introduces several major enhancements and new features to the issuing and disputes modules, as well as expands the API client surface for cards, controls, and simulated transactions. The changes include the addition of new request and response models, new client methods for dispute and card management, and extended support for control groups and profiles.

Issuing Cards and Card Management Enhancements:

• Added new request models for updating, renewing, and scheduling revocation of cards, including support for card metadata, and introduced corresponding client methods for these operations in IssuingClient. [1] [2] [3] [4] [5] [6] [7] [8]

Disputes and Evidence Handling:

• Introduced new request and data models for creating and escalating disputes, including evidence and reason change structures, and added new methods to IssuingClient for dispute lifecycle management. [1] [2]
• Enhanced the disputes client with arbitration evidence submission and retrieval methods. [1] [2]

Controls, Control Groups, and Profiles:

• Expanded the controls module with new types and enums (e.g., MID_LIMIT, FailIfType), added support for MID-based limits, and introduced models and client methods for control groups and control profiles, enabling more granular and grouped control management. [1] [2] [3] [4] [5] [6]

Testing and Simulation Improvements:

• Added simulation request/response models for refund authorizations and out-of-band (OOB) authentication, and extended IssuingClient with methods to simulate these scenarios. [1] [2] [3]

API Client Surface Expansion:

• Registered new API clients for network tokens and payment methods in the main API client initialization. [1] [2]

API Schemas review:

• All the requests schemas have been reviewed to detect missing or changed fields with the latest swagger specifications, several updates have been done including: new fields, renames, typo fixes, etc.

These changes significantly enhance the flexibility and capability of the SDK for managing cards, disputes, and controls, and provide improved support for testing and simulation scenarios.

3.6.1

Release 3.6.1 (#206)

This release makes a small update to the project's dependencies by adding the Deprecated package to the install_requires list in setup.py. This ensures that the package is installed alongside the other dependencies.

• Added Deprecated >= 1.2.14 to the install_requires section in setup.py to manage deprecated functionality.

3.6.0

Release - 3.6.0 (#204)

This release introduces several new features and enhancements across the SDK, including support for agentic commerce, compliance requests, expanded account management, and improved HTTP header handling. The most significant changes are the addition of new client modules, new data models, and enhancements to the API client to support custom headers.

New SDK Modules and Features:

• Added support for Agentic Commerce, including new models in agentic_commerce.py and a corresponding client in agentic_commerce_client.py for delegated payment flows. [1] [2]
• Introduced Compliance Requests functionality with new models (compliance_requests.py) and a client (compliance_requests_client.py) to retrieve and respond to compliance requests. [1] [2]
• Updated checkout_api.py to expose new clients for agentic commerce, compliance requests, Apple Pay, Google Pay, standalone account updater, AML screening, face authentication, ID document verification, applicants, and identity verification, making these services available via the main API entry point. [1] [2] [3] [4]

Enhancements to Account Management:

• Added models and client methods for reserve rules, entity file uploads, and sub-entity member management in the accounts module. This includes new classes such as ReserveRuleRequest, FilePurpose, and related API client methods for CRUD operations on reserve rules and entity files. [1] [2] [3] [4] [5]

API Client Improvements:

• Enhanced ApiClient to support passing custom headers for POST, PUT, and PATCH requests, including logic to map model properties to HTTP headers (e.g., for ETag or API versioning). This allows for more flexible and standards-compliant API interactions. [1] [2] [3] [4]

Additional Data Models:

• Added new data models for forward requests and secret requests, expanding the flexibility of the SDK in handling various request types.

These changes collectively expand the SDK's capabilities, improve extensibility, and enhance support for new Checkout.com platform features.