Skip to content

[PIMOB-4287]: adding base url prefix to Frames SDK for multi-region#302

Merged
zane-smith-cko merged 13 commits intomasterfrom
feature/PIMOB-4287_add_subdomain_prefix
Mar 11, 2026
Merged

[PIMOB-4287]: adding base url prefix to Frames SDK for multi-region#302
zane-smith-cko merged 13 commits intomasterfrom
feature/PIMOB-4287_add_subdomain_prefix

Conversation

@zane-smith-cko
Copy link
Contributor

@zane-smith-cko zane-smith-cko commented Mar 6, 2026

Issue

PIMOB-4287

Proposed changes

Added baseUrlPrefix as a parameter for Frames configuration

  • Example app subdomain base url now uses 'global'
  • If baseUrlPrefix's sub domain is not alphanumeric then we do not accept it and we use the standard environment set URL without a prefix.
  • PK + SK has been updated.

Test Steps

  1. Pay with via card or via CVV
  2. Observe API call being made from global subdomain.

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • Reviewers assigned
  • I have performed a self-review of my code and manual testing
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if applicable)

Further comments

Screen.Recording.2026-03-09.at.14.20.32.mov

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds support for an optional subdomain/base-URL prefix so tokenization requests can be routed via a regional/merchant-specific subdomain, and wires this through Frames + CVV flows with updated samples and tests.

Changes:

  • Introduces baseUrlPrefix in Frames configuration/DI and propagates it down to CheckoutApiServiceFactory.
  • Adds Environment.toBaseUrl(...) URL building with prefix validation and corresponding unit tests.
  • Updates example apps and unit tests to pass the new prefix argument(s).

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
frames/src/test/java/com/checkout/frames/screen/paymentform/PaymentFormViewModelTest.kt Updates test setup to include baseUrlPrefix when constructing the VM factory.
frames/src/test/java/com/checkout/frames/screen/paymentform/PaymentFormConfigTest.kt Extends config test coverage to include baseUrlPrefix.
frames/src/test/java/com/checkout/frames/mock/PaymentFormConfigTestData.kt Adds test data constant for baseUrlPrefix.
frames/src/test/java/com/checkout/frames/cvvinputfield/InternalCVVComponentApiTest.kt Updates CVV API test to include baseUrlPrefix.
frames/src/test/java/com/checkout/frames/cvvinputfield/CVVComponentApiFactoryTest.kt Updates factory test for new create(...) signature.
frames/src/main/java/com/checkout/frames/screen/paymentform/model/PaymentFormConfig.kt Adds public config field baseUrlPrefix.
frames/src/main/java/com/checkout/frames/screen/paymentform/PaymentFormViewModel.kt Threads baseUrlPrefix into injector creation.
frames/src/main/java/com/checkout/frames/screen/paymentform/PaymentFormScreen.kt Passes config baseUrlPrefix into VM factory.
frames/src/main/java/com/checkout/frames/di/injector/FramesInjector.kt Threads baseUrlPrefix into CheckoutApiServiceFactory.create(...) and DI builder.
frames/src/main/java/com/checkout/frames/di/component/FramesDIComponent.kt Adds @BindsInstance baseUrlPrefix to Dagger builder.
frames/src/main/java/com/checkout/frames/cvvinputfield/api/InternalCVVComponentApi.kt Threads baseUrlPrefix into CheckoutApiServiceFactory.create(...) for CVV tokenization.
frames/src/main/java/com/checkout/frames/cvvinputfield/CVVComponentApiFactory.kt Extends CVV factory API to accept baseUrlPrefix.
example_app_frames/src/main/java/com/checkout/example/frames/ui/utils/Constants.kt Adds demo constant for regional subdomain and updates demo keys.
example_app_frames/src/main/java/com/checkout/example/frames/ui/screen/MainActivity.kt Passes regional subdomain into PaymentFormConfig.
example_app_frames/src/main/java/com/checkout/example/frames/ui/screen/HomeScreen.kt Passes regional subdomain into CheckoutApiServiceFactory.create(...).
example_app_frames/src/main/java/com/checkout/example/frames/ui/screen/CVVTokenizationScreen.kt Passes regional subdomain into CVVComponentApiFactory.create(...).
checkout/src/test/java/com/checkout/EnvironmentExtensionTest.kt Adds unit tests for Environment.toBaseUrl(...) behavior.
checkout/src/test/java/com/checkout/CheckoutApiServiceFactoryTest.kt Updates factory test for new signature.
checkout/src/main/java/com/checkout/logging/utils/EnvironmentExtension.kt Adds Environment.toBaseUrl(...) and prefix validation helper.
checkout/src/main/java/com/checkout/base/model/Environment.kt Refactors Environment enum to remove url field.
checkout/src/main/java/com/checkout/CheckoutApiServiceFactory.kt Adds baseUrlPrefix parameter and uses Environment.toBaseUrl(...) for tokenization base URL.
app/src/main/java/checkout/checkout_android/DemoActivity.java Updates demo to pass regional subdomain into PaymentFormConfig.
app/src/main/java/checkout/checkout_android/Constants.java Adds regional subdomain constant and updates demo keys.
app/src/main/java/checkout/checkout_android/CVVTokenizationActivity.java Updates demo to pass regional subdomain into CVVComponentApiFactory.create(...).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@zane-smith-cko zane-smith-cko changed the title Feature/pimob 4287 add subdomain prefix [PIMOB-4287]: adding base url prefix to Frames SDK for multi-region Mar 9, 2026
@zane-smith-cko zane-smith-cko force-pushed the feature/PIMOB-4287_add_subdomain_prefix branch from a274ee9 to 3dd091f Compare March 9, 2026 10:58
@zane-smith-cko zane-smith-cko marked this pull request as ready for review March 9, 2026 14:23
@zane-smith-cko zane-smith-cko requested a review from a team as a code owner March 9, 2026 14:23
Copy link

@adrian-orlowski-cko adrian-orlowski-cko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Thank you for rotating the keys!

@zane-smith-cko zane-smith-cko merged commit 191e36a into master Mar 11, 2026
33 of 36 checks passed
@zane-smith-cko zane-smith-cko deleted the feature/PIMOB-4287_add_subdomain_prefix branch March 11, 2026 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants