Skip to content

utrustdev/utrust-for-magento2

Repository files navigation

Utrust integrations

Utrust for Magento 2.4

Accept Bitcoin, Ethereum, Utrust Token and other cryptocurrencies directly on your store with the Utrust payment gateway for Magento. Utrust is cryptocurrency agnostic and provides fiat settlements. The Utrust plugin extends Magento allowing you to take cryptocurrency payments directly on your store via the Utrust API. Find out more about Utrust at utrust.com.

Requirements

  • Utrust Merchant account
  • Online store in Magento 2.4.x or 2.3.x

Install and Update

Install

You will need FTP and SSH access to install this module:

  1. Download our latest release zip file on the releases page or Utrust Payment extension page.
  2. Unzip the zip file in app/code/Utrust/Payment.
  3. Enable the module by running bin/magento module:enable Utrust_Payment
  4. Apply database updates by running bin/magento setup:upgrade
  5. Flush the cache by running bin/magento cache:flush
  6. Go to your Magento admin dashboard (it should be something like https://<your-store.com>/admin).
  7. If you go to Stores -> Sales -> Payment Methods and Utrust is there it's successfully installed!

** Note: In production please use the --keep-generated option **

Update

You can always check our releases page for a new version. You can update by following the same instructions as installing.

Uninstall (without Composer)

If removing with Composer doesn't work (which is recommended), you can try to remove it manually:

bin/magento module:disable Utrust_Payment
bin/magento setup:upgrade
rm -rf app/code/Utrust
bin/magento cache:clean
bin/magento setup:static-content:deploy -f

Setup

On the Utrust side

  1. Go to Utrust merchant dashboard.

  2. Log in or sign up if you didn't yet.

  3. On the left sidebar choose Integrations.

  4. Select Magento 2 and click the button Generate Credentials.

  5. You will see now your Api Key and Webhook Secret, save them somewhere safe temporarily.

    ⚠️ You will only be able to see the Webhook Secret once, after refreshing or changing page it will be no longer available to copy; if needed, you can always generate new credentials.

    🚫 Don't share your credentials with anyone. They can use it to place orders on your behalf.

On the Magento side

  1. Go to your Magento admin dashboard.
  2. Navigate to Stores -> Configuration -> Sales -> Payment Methods -> Utrust.
  3. Add your Api Key and Webhook Secret and click "Save Config" button on top.
  4. Done!

Features

✨ These are the features already implemented and planned for the Utrust for Magento 2 plugin:

  • Creates Order and redirects to Utrust payment widget
  • Receives and handles webhook payment received
  • Receives and handles webhook payment cancelled
  • Starts automatic refund on Utrust when refund initiated in Magento

Support

Feel free to reach by opening an issue on GitHub if you need any help with the Utrust for Magento 2 plugin.

If you're having specific problems with your account, then please contact support@utrust.com.

In both cases, our team will be happy to help 💜.

Contribute

This plugin was initially written by a third-party contractor (Moisés Sequeira from CloudInfo), and is now maintained by the Utrust development team.

We have now opened it to the world so that the community using this plugin may have the chance of shaping its development.

You can contribute by simply letting us know your suggestions or any problems that you find by opening an issue on GitHub.

You can also fork the repository on GitHub and open a pull request for the master branch with your missing features and/or bug fixes. Please make sure the new code follows the same style and conventions as already written code. Our team is eager to welcome new contributors into the mix 😊.

Development

If you want to get your hands dirty and make your own changes to the Utrust for Magento plugin, we recommend you to install it in a local Magento store (either directly on your computer or using a virtual host) so you can make the changes in a controlled environment. Alternatively, you can also do it in a Magento online store that you have for testing/staging.

Once the plugin is installed in your store, the source code should be in app/code/Utrust/Payment/. All the changes there should be reflected live in the store (if it doesn't, go to System -> Cache Management and flush the cache). If something goes wrong with the module, logs can be found in var/log/utrust.log.

Publishing

For now only members of the Utrust development team can publish new versions of the Utrust for Magento 2 plugin.

To publish a new version, simply follow these instructions.

License

The Utrust for Magento 2 plugin is maintained with 💜 by the Utrust development team, and is available to the public under the GNU GPLv3 license. Please see LICENSE for further details.

© Utrust 2021