When should I use the Commerce Payment Integration client extension type?

• You're onboarding a payment provider Commerce doesn't ship natively. • You need a private / regional payment method.

How do I create a Commerce Payment Integration client extension?

1. Ship a paired `oAuthApplicationUserAgent`. 2. Provide provider-specific settings via `paymentIntegrationTypeSettings:` (apiKey, environment, hmacSignature, etc.).

Commerce Payment Integration

Integrate a payment provider with Liferay Commerce.

type: commercePaymentIntegration·Commerce

# description

Registers a payment provider — Stripe, Adyen, PayPal, etc. Commerce checkout routes payment intents through your provider via the paired OAuth user-agent app.

Payment, shipping, tax, and checkout integrations for Liferay Commerce.

# when to use

→You're onboarding a payment provider Commerce doesn't ship natively.
→You need a private / regional payment method.

# how to use

01Ship a paired oAuthApplicationUserAgent.
02Provide provider-specific settings via paymentIntegrationTypeSettings: (apiKey, environment, hmacSignature, etc.).

# optional fields

field	type	description
`name`	`string`	Display name.
`key`	`string`	Internal Commerce reference code.
`oAuth2ApplicationExternalReferenceCode`	`string`	Ref code of the paired oAuthApplicationUserAgent.
`paymentIntegrationType`	`integer`	Integration mode (per Commerce docs).
`paymentIntegrationTypeSettings`	`map`	Provider-specific settings.

# example

client-extension.yaml

stripe-payments:
    type: commercePaymentIntegration
    name: Stripe
    key: stripe-payments
    oAuth2ApplicationExternalReferenceCode: stripe-oauth
    paymentIntegrationTypeSettings:
        apiKey: sk_test_...
        environment: test

# related types

Usually shipped alongside Commerce Payment Integration:

❯OAuth Application (User Agent)— Register a browser / SPA OAuth application.

# more in commerce

cd ..scaffold this type in VS Code →