Airwallex logo
Airwallex logoAirwallex logo

Prepare and import metadata

Import the required system objects, services, payment methods, and jobs into your SFCC realm.

Copy for LLMView as Markdown

To set up the Airwallex Payments Cartridge in your Salesforce Commerce Cloud (SFCC) realm, first import the metadata package that creates all required configurations. The metadata import creates system object extensions, custom objects, services, payment methods, payment processors, and scheduled jobs.

Before you begin

  • You have SFCC Administrator access with permissions to upload code, import site data, and configure Business Manager.
  • You have the Storefront Reference Architecture (SFRA) repository cloned and deployed to your realm.
  • You have an Airwallex account with API credentials (Client ID and API key) for your target environment.

What gets imported

The metadata import creates the following components in your SFCC realm:

ComponentDetails
Site PreferencesAirwallex settings group (awx_v1_*) — environment, API credentials, feature toggles
System Object ExtensionsCustom attributes on Basket, Order, and OrderPaymentInstrument
Custom ObjectAirwallexWebhookEvent — queue for asynchronous webhook processing
Payment ProcessorsAIRWALLEX_CREDIT_CARD, AIRWALLEX_ONLINE
Payment MethodsAirwallexCreditCard, AirwallexOnline
ServiceAirwallexPublicAPI — HTTP service for Airwallex API calls
JobAirwallexProcessWebhooks — processes webhook events every 5 minutes

Prepare the metadata package

To prepare the metadata package for your site, complete these steps:

  1. Open the metadata/site_import/ folder in the repository.

  2. Inside metadata/site_import/sites/, rename the RefArchGlobal folder to match your site ID as it appears in Business Manager (for example, RefArch, or your custom site ID).

  3. Open metadata/site_import/jobs.xml and replace RefArchGlobal in the <context site-id="RefArchGlobal"/> element with your site ID:

    xml
    1<context site-id="YourSiteId"/>

  4. Create a ZIP archive of the site_import folder. The ZIP must contain the site_import folder at its root.

Import the metadata

To import the metadata package into your SFCC realm, complete these steps:

  1. In Business Manager, go to Administration > Site Development > Site Import & Export.

  2. Click Upload and select your ZIP file.

  3. After the upload completes, select the archive and click Import.

  4. Verify the import completes without errors.

Verify the import

After importing, confirm the following components were created:

  • Administration > Site Development > System Object Types > SitePreferences > Attribute Definitions — Attributes prefixed with awx_v1_ appear.
  • Administration > Site Development > System Object Types > Order > Attribute Definitions — Attributes prefixed with awx appear.
  • Administration > Site Development > Custom Object Types — AirwallexWebhookEvent appears.
  • Merchant Tools > Ordering > Payment Methods — AirwallexCreditCard and AirwallexOnline appear.
  • Merchant Tools > Ordering > Payment Processors — AIRWALLEX_CREDIT_CARD and AIRWALLEX_ONLINE appear.
  • Administration > Operations > Services — AirwallexPublicAPI service, credential, and profile appear.
  • Administration > Operations > Jobs — AirwallexProcessWebhooks appears.

Next steps

Now that you have imported the metadata, build and upload the cartridge code to your realm:

Was this page helpful?