Integrating via Adobe Commerce

Use this guide when you want to offer Azupay Pay by Bank in your Adobe Commerce store.

The Adobe Commerce integration allows you to connect Azupay to your storefront, configure the payment experience, and offer customers a bank-based checkout flow using PayID, PayTo, or both, depending on your agreed setup.

Overview

With the Adobe Commerce integration, you can:

• add Azupay Pay by Bank to your Adobe Commerce checkout
• configure the payment experience through Azupay and Adobe Commerce
• test the end-to-end payment flow before going live
• manage orders and refunds through your existing Adobe Commerce workflows

This is best suited to merchants who want to add Azupay Pay by Bank into an existing Adobe Commerce storefront without building the full checkout experience from scratch.

Before you begin

Before starting the integration, make sure you have:

• access to your Adobe Commerce admin
• access to the Azupay Merchant Dashboard
• the Azupay credentials or onboarding information provided to your business
• clarity on whether you want to offer:
  • PayID only
  • PayTo only
  • or both

Prerequisites checklist

Configure Azupay Checkout App

Before enabling the Adobe Commerce plugin, configure your checkout experience in Azupay.

Step 1: Enable the Checkout App in the Azupay Merchant Dashboard

In the Azupay Merchant Dashboard:

1. Open the relevant merchant configuration.
2. Enable the Checkout App for your business.
3. Confirm which payment methods should be available:
   • PayID
   • PayTo
   • or both
4. If both are enabled, confirm which payment method should be shown first in checkout.

Step 2: Create an Azupay API key

Generate or obtain the API key required for your Adobe Commerce integration.

This key is used to connect your Adobe Commerce store to Azupay and allow payment requests to be created securely.

Keep your API key secure and only use the key intended for the relevant environment, such as test or production.

Configure the Azupay plugin in Adobe Commerce

Once the Azupay side is ready, configure the Adobe Commerce plugin in your store.

Step 1: Open the Adobe Commerce payment configuration

In Adobe Commerce admin:

1. Go to the payment configuration area for your store.
2. Find the Azupay Pay by Bank plugin or payment method settings.
3. Open the plugin configuration page.

Step 2: Enter your Azupay settings

Enter the values provided during onboarding or generated in the Azupay Merchant Dashboard.

This typically includes:

• API credentials
• environment-specific settings
• store or merchant-linked configuration
• payment method options such as PayID, PayTo, or both

Step 3: Save and enable the plugin

After entering the required settings:

1. Save the configuration.
2. Enable the Azupay payment method.
3. Confirm the payment option appears in the Adobe Commerce checkout.

Configuration tips

How the Adobe Commerce payment flow works

Once configured, the customer journey is straightforward.

1. The customer adds items to their cart.
2. They proceed through the Adobe Commerce checkout.
3. They select Azupay Pay by Bank as the payment method.
4. They are redirected to Azupay’s hosted payment experience.
5. They complete payment using PayID, PayTo, or the configured payment option.
6. They return to the Adobe Commerce order flow.

sequenceDiagram
    participant C as Customer
    participant AC as Adobe Commerce
    participant A as Azupay Pay by Bank
    participant B as Customer Bank

    C->>AC: Add items and proceed to checkout
    C->>AC: Select Azupay Pay by Bank
    AC->>A: Redirect to hosted payment experience
    A->>C: Show PayID, PayTo, or both
    C->>B: Complete payment
    B-->>A: Payment confirmed
    A-->>AC: Return customer to order flow
Test your integration
Before going live, test the integration end to end.

Test checklist
confirm the Azupay payment method appears in Adobe Commerce checkout
confirm the customer can be redirected into the Azupay hosted payment experience
confirm the enabled payment methods match your intended setup
confirm successful payments appear correctly in Adobe Commerce
confirm failed, cancelled, or incomplete journeys are handled cleanly
confirm webhook-driven or status-based order updates work as expected
Suggested testing steps
Place a test order in Adobe Commerce.
Select Azupay Pay by Bank at checkout.
Complete the payment using the appropriate test flow.
Confirm the order updates correctly in Adobe Commerce.
Repeat for any other payment options enabled, such as PayID and PayTo.
Manage payments in Adobe Commerce
Once live, payments made through Azupay Pay by Bank can be managed through your existing Adobe Commerce order workflows.

Viewing payment information
Use Adobe Commerce order management to review:

the order status
the payment method used
the payment outcome associated with the order
Processing refunds
Refunds should be processed through the normal Adobe Commerce order management flow for the Azupay payment method.

Use the relevant order in Adobe Commerce to:

open the order
select the refund or credit memo workflow
enter the refund details
submit the refund
<Callout theme="default"> Refund handling should be tested before go-live so your team understands the expected Adobe Commerce and Azupay behaviour. </Callout>
Understanding payment status
Depending on the payment outcome, your Adobe Commerce order and payment records may reflect different states.

Typical states to verify during testing include:

successful payment
cancelled payment
incomplete payment
expired payment request, where relevant
Troubleshooting
Common issues
<Accordion title="The payment method is not showing in checkout" icon="fa-circle-question"> Check that: - the Azupay plugin is enabled in Adobe Commerce - the plugin is configured with the correct credentials - the correct payment methods are enabled in Azupay - the store is using the intended environment </Accordion> <Accordion title="Customers cannot complete payment" icon="fa-circle-question"> Check that: - the hosted checkout configuration is correct - the customer is being redirected to Azupay successfully - the enabled payment methods match your intended setup - there are no configuration mismatches between Adobe Commerce and Azupay </Accordion> <Accordion title="Refunds are not behaving as expected" icon="fa-circle-question"> Check that: - the refund is being initiated from the correct Adobe Commerce order flow - the original order was paid using Azupay Pay by Bank - your team has tested the refund flow in the current environment </Accordion>
Debug mode and logs
If troubleshooting is required, review:

Adobe Commerce payment logs
plugin-specific logs, if enabled
Azupay-side configuration and support notes
Logs are especially helpful when:

the payment method does not appear
the checkout redirect fails
the order status does not update correctly
refunds do not reconcile as expected
Support
Before contacting support
Have the following ready:

your store name
the environment affected
the order number or transaction reference
whether the issue relates to setup, checkout, payment status, or refund
screenshots or logs where available
Azupay support
If you need help with onboarding, plugin configuration, testing, or troubleshooting, contact Azupay support and include the details above so the issue can be investigated more quickly.