Skip to main content

Gateway SDK Capability Matrix

Updated: 2026-06-20

This is the support reference for Gateway SDK usage in the monorepo. The retired peak-api integration notes are no longer current implementation guidance.

Current Integration Surface

CapabilityCurrent ownerCode pointer
Gateway admin/pay client constructionmanagement-apiapps/microservices/management-api/src/main/java/com/myriad/management_api/gateway/GatewayClientConfig.kt
Organization, location, provisioning, settlementsmanagement-apiapps/microservices/management-api/src/main/java/com/myriad/management_api/gateway/ManagementGatewayService.kt
Tax config CRUD and tax calculationmerchant-apiapps/microservices/merchant-api/src/main/kotlin/com/myriad/merchant_api/service/TaxConfigService.kt, TaxCalculationService.kt
Hosted checkout session create/readmanagement-apiapps/microservices/management-api/src/main/java/com/myriad/management_api/gateway/GatewayCheckoutSessionClient.kt
Card-present device requestsmanagement-apiapps/microservices/management-api/src/main/java/com/myriad/management_api/gateway/GatewayCardPresentDeviceClient.kt
Unified POS/Gateway transaction read joinmanagement-apiapps/microservices/management-api/src/main/java/com/myriad/management_api/gateway/joinlayer/UnifiedTransactionsService.kt
Terminal card-present activation/runtime cacheAndroid + shared KMP SDKapps/android/, libs/sdks/kotlin/peak-pos-sdk/

Generated SDK drift is guarded by repository tests under libs/sdks/ and by the OpenAPI/SDK contract checks in scripts/test-local.sh contracts.

Capability Notes

  • GatewayPayClient.checkoutSessions.create() is used for hosted checkout session creation through the management-api Gateway checkout client.
  • GatewayAdminClient.organizations, locations, provisioning, settlements, and transaction APIs are consumed through the management-api Gateway package. taxConfig and tax calculation are owned by merchant-api (TaxConfigService.kt, TaxCalculationService.kt).
  • Card-present device operations use the Gateway URLs and credentials from management-api Gateway properties and must not log raw credentials.
  • Android/iOS Gateway runtime proof is separate from service compile proof: build the APK/XCFramework where possible, then classify device/runtime checks as external unless a reachable approved device or host is available.

Validation

Use the canonical local commands:

./scripts/test-local.sh contracts
./scripts/test-local.sh quick
./scripts/test-local.sh external-gates

For Gateway Maven artifact access failures, source credentials first:

source scripts/gateway-maven-credentials.sh

The helper accepts explicit Gateway Maven credentials and authenticated Google Cloud/ADC fallbacks. Treat 401/403 as a credential-remediation step before classifying Gateway Maven as blocked.