- Sign up for a Xumm Developer account, if you don't already have one.
- Install the plugin in nopCommerce.
- Configure the API Credentials and set your XRPL Account with optional destination tags.
- You're all set to receive payments and process refunds.
You can select XRP or any other XRPL token as currency from a list that contains all the trust lines set in your account and curated assets of Xumm.
Customers can pay with any XRPL token while the ledger handles the conversion to your shop currency after XUMM Issue 392 is implemented and released. For now the payment by the customer has to be done with the same token as the configured XRPL Currency.
Refunds are made possible by using the mailing system of nopCommerce because transactions on the XRPL need to be signed. The refund email will be send to the logged in user that initiates the refund via the admin panel and will contain a link to the Xumm sign page of https://xumm.app/ containing the QR-code.
Sign up for a Xumm Developer account, if you don't already have one.
Once you have access to the Xumm Developer Dashboard, you will be able to create an application with the required API Credentials.
The credentials can be found inside the Xumm Developer Dashboard > Settings > Application credentials section.
After that, please input https://<your-store-url>/Plugins/Xumm/Webhook as the Webhook URL in the Application details section.
The Xumm Payment Module can be downloaded at the nopCommerce Marketplace. More installation details can be found in the nopCommerce Documentation.
After installing the plugin, you can navigate to Configuration > Payment methods on the navigation menu of the admin panel.
You will be able to see “Xumm” on the list, click Configure.
First you need to configure the API Key and Secret found of the Application credentials section at the Developer Dashboard. The application will restart after save to apply the API Credentials since these are set at startup.
Other settings will be visible if the configured credentials are valid.
Xumm uses webhooks to process payments and refunds and it's required to configure the URL in the Developer Dashboard. The payment method will be hidden in the shoppingcart if the Webhook URL shown at the plugins configuration page is not configured.
Using the "Sign in with Xumm" button to set the XRPL Address is recommended to prevent a wrongly configured XRPL Address.
Changing the address could change the XRPL Currency to XRP if the new account doesn't have a trust line set of the previously configured XRPL Currency,
The XRPL Currency can be configured if the XRPL Address is valid and the list is populated with Xumm's Curated Assets, Trust Lines of XRPL Address and XRP.
You will be redirected to the required TrustSet flow if a curated asset has been selected but no trust line has been set on the configured XRPL Address. The selected XRPL Currency will only be saved if the Trust Line is set during this flow.
A Shop Currency equal to theXRPL Currency has to exist and set as the Primary Store Currency. An error message at the configuration page will be shown if the shop currency is missing and the Xumm payment method will be hidden in the shoppingcart.
The Xumm payment method will be hidden for consumers if the trust line of XRPL Currency has been removed from XRPL Address. For the ease of use a button will be shown next to the drop down list at the configuration page to redirect to the TrustSet flow.
An optional destination tag can be set separately for payments and refunds. A destination tag is formatted as a 32-bit unsigned integer.
The API Key, API Secret, Webhook URL, XRPL Address and XRPL Currency has to be configured as required.
The Xumm payment method will not be visible for consumers if not configured correctly.