Upgrade from Payouts Web SDK
Refer to this guide if your integration uses Airwallex Payouts Web SDK
The Airwallex Payouts Web SDK JavaScript library has been deprecated. For the latest features and customization options for Transfer Element and Beneficiary Element, please upgrade to Airwallex.js JS. This guide covers the changes made and instructions for migrating to Airwallex.js.
Update JavaScript client library
npm/yarn/pnpm installation
Install the new package.
- Before: airwallex-payouts-web-sdk
- After: @airwallex/components-sdk
cdn installation
Update the URL in the <script> tag.
- Before:
<script src="https://static.airwallex.com/widgets/payouts/sdk/v1/index.js"></script> - After:
<script src="https://static.airwallex.com/components/sdk/v1/index.js"></script>
After installation, you will need to initialize the SDK by calling the init() method.
Update SDK functions
init()
New parameters
enabledElements: An array of Element groups representing the Elements. For example, to use Payouts elements, setenabledElementstopayouts.locale: The specified locale will be applied to both the Element UI strings and error messages unless overridden by thelocalefield at the Payout Element level. Supportsen,zh,zh-HK,de,es,fr,it,ja,kowith onlyensupport available for Tax Form Element.
Deprecated parameters
langKey
BEFORE
JavaScript
AFTER
JavaScript
createElement()
No changes to the function other than the import source.
BEFORE
JavaScript
AFTER
JavaScript