---
# System prepended metadata

title: Jarvix Pay Magento payment plugin installation guide

---

# Jarvix Pay Magento payment plugin installation guide

## Content
1. [Prerequisite](#Prerequisite)
2. [Schema](#Schema)
3. [Installation](#Installation)
4. [Configuration](#Configuration)
5. [Appendix](#Appendix)
    - [Test_card_number](#Test_card_number)

## Prerequisite
1. Magento version 2 or later installed
2. Magento admin panel access(for plugin configuartion)
3. Server access(for plugin installation)

## Environment
Jarvix Pay provides a sandbox environment and a production environment.

Sandbox url
>https://online-payment.staging.pay.jarvix.ai/pay/

Production url
>https://online-payment.pay.jarvix.ai/pay/


## Installation
1. Register Jarvix Pay online payment service
2. Jarvix Pay access credentials (`account_id` and `secret_key`) will be sent.
`account_id` is an `uuid4` string and `secret_key` is a 32 random charaters string.(`secret_key` should not be publicly accessible)

Example:

| Name       | Type                        | Example                              |
|:---------- | --------------------------- |:------------------------------------ |
| account_id | uuid                        | f371ca37-f347-4bb9-bfa9-28f70466d0a3 |
| secret_key | 32 random characters string | Hlyo2D8tVTCSSO2OA8Gr7S6nVgFDvkDl     |

3. Download Jarvix Pay Magento payment plugin: `JarvixPay_Magento_plugin.zip`
4. Copy the file to `<magento document root>/app/code`, e.g. `/var/www/html/app/code`
5. Run command`bin/magento cache:clean && rm -rf var/cache/* && rm -rf var/generation/* && bin/magento cache:flush && bin/magento setup:upgrade` under `<magento document root>`

## Configuration
1. Login magento admin panel![](https://i.imgur.com/jWNxIHg.png)
2. Go to `Stores > Configuration`![](https://i.imgur.com/uAbiHxm.png)
3. Go to `Sales > Payment Methods`![](https://i.imgur.com/ZnCJccd.png)
4. On the Jarvix Pay configuration page:
    - Enable the plugin
    - Type your `account_id` and `secret_key`
    - Enable debug mode if you are testing
![](https://i.imgur.com/WbClLpt.png)

5. Save your configuration![](https://i.imgur.com/kV3AtWs.png)

## Remarks
1. Please do not expose you access credential in public.
2. The access credential for sandbox and production are different.

## Appendix

### Test_card_number
| Card Number         | Brand            | CVC          | Date(MM/YYYY)   | Description        |
| ------------------- | ---------------- | ------------ | --------------- | ------------------ |
| 4242 4242 4242 4242 | Visa             | Any 3 digits | Any future date | successful payment |
| 5555 5555 5555 4444 | Master           | Any 3 digits | Any future date | successful payment |
| 3782 822463 10005   | American Express | Any 4 digits | Any future date | successful payment |
| 4000 0000 0000 0002 | -                | Any 3 digits | Any future date | declined charege   |

