Cryptocurrency Payment Gateway API Integration Guide

Step 1: Create an account

For New Merchant: To establish a new merchant account with MaxelPay, follow these steps:

• Create an account by visiting the registration page. You also have the option to sign up using your Google account for a faster registration process. Choose any option that is most convenient for you. 

• Enter your First and Last Name and Email Address to create a new account.

• Click the "Continue" button to proceed with your registration.

• After clicking "Continue," check your email for the One-Time Password (OTP). Enter the “Code” as shown in the image below.

• If you did not receive the OTP, click on "Resend OTP" to get a new one.

After entering the OTP, click the "Continue" button. Your account will be created, and you will be taken to the “MaxelPay dashboard”. This is where you can create invoices, manage your account settings, view transaction details, and set up your payment integration.

Upon your first login, the dashboard will not display any data. This is normal, as you have not yet received any cryptocurrency payments via Maxelpay. Once transactions are processed, your account will update to reflect the relevant activity and balance.

Existing Merchants: Log in with your previously registered email and password on the login page.

Step 2: Go To Dashboard

Choose The Environment: enable or disable the test mode.

• From the MaxelPay dashboard, you can toggle the Test Mode ON or OFF.

• When Test Mode is enabled, you can perform transactions as if they were real, allowing you to ensure that your integration works as intended. However, please note that during this mode, you will not receive actual payments but you can receive test currency.

• To start receiving real payments, you must disable Test Mode. Ensure that you have thoroughly tested your integration before switching to live mode.

Step 3: Create Your Wallet

• Click on Continue to  "Create Your Wallet" link as shown in the image below.

• Click "Generate Wallet" as indicated.

• Set up a “Secure PIN” for your wallet.

• Your wallet will be created successfully. Take a backup of your wallet; a “.txt file” will be downloaded and saved in your device. An email will be sent with the files containing the Set PIN and encoded private key. 

• Your wallet is now ready to use, enabling you to easily manage your transactions, store your digital assets securely, and make instant payments.

Step 3: Plugin And Library Installations 

Go to the “Developers” section from the left sidebar of your dashboard. Here you will find your API Key and API Secret Key. These credentials are essential for authenticating your requests to the MaxelPay API. Keep them secure and do not share them publicly. Hover on “Get Code”. Here you can choose PHP, Python, React/Node, .Net and Java and copy the encryption code of languages selected. MaxelPay provides a variety of package options for seamless integration with multiple platforms:

• For Wordpress Websites: Install the MaxelPay Woocommerce plugin from the official WordPress repository: MaxelPay WooCommerce Plugin.

• For Laravel Package: For Laravel applications, you can install the MaxelPay package via Composer: MaxelPay Laravel Package.

• NPM Package (for Node.js): Use the MaxelPay JavaScript SDK in your Node.js application: MaxelPay NPM Package.

Step 4: Adding a Webhook URL

After completing the integration and establishing a connection between MaxelPay and your website, you will need to add a Webhook URL. This URL will direct users to a designated page after a successful transaction.

How To Integrate Crypto Payment Gateway Checkout API

API EndPoint URLs:

Method: POST

Headers:

Payload: The payload must be sent securely. You may use encryption to protect it during the payload data transmission. The developer or user can choose or copy the encryption code of any listed language from the Request Example provided at the right side.

Encryption Mode: AES-256-CBC

Payload Data Attributes:

Supported Currencies List

Encryption: 

Stepwise Guide to Encrypt the Payload data.

• Prepare the Data: Get the plain text (Payload data) that you want to encrypt.

• Choose Encryption Method: AES-256-CBC is an encryption method that uses a 256-bit key and works in Cipher Block Chaining (CBC) mode or You can use the CryptoJS library for this, which has built-in support.

• Secret Key: Use the provided secret key for encryption.

• Set Options (Scheme): When set to true, the function returns the raw binary data.

• Generate Initialization Vector (IV): Take the first 16 characters (or bytes) from the secret key and use them as the IV.

Use your custom encryption method with these parameters: plain text data, encryption method, secret key, options, IV, and handle the encrypted output.

Request Examples

/**

* Encryption example & Call: * An example of payload data: */

let payload = {

"orderID": "113099",

"amount": "100",

"currency": "USD",

"timestamp": "1717666706",

"userName": "ABC",

"siteName": "Maxelpay",

"userEmail": "abc@gmail.com",

"redirectUrl" :"https://example.com/checkout/order-received/113099/?key=order_IRZTHBRCp3pcg",

"websiteUrl": "https://example.com",

"webhookUrl": "http://example.com/wp-json/maxelpay/api/order_status"

}

const secret_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

/**

* For module import

import CryptoJS from 'crypto-js' */

/**

* For common js import

*/

const CryptoJS=require('crypto-js')

const encryption = ( secret_key, payload ) => {

const key = CryptoJS.enc.Utf8.parse(secret_key);

const ivHex = CryptoJS.enc.Utf8.parse(secret_key.substr(0, 16));

const encrypted = CryptoJS.AES.encrypt(payload, key, {

iv: ivHex, mode:CryptoJS.mode.CBC, padding:CryptoJS.pad.Pkcs7

});

return encrypted.toString();

};

payload = JSON.stringify( payload );

const encrypt_payload = encryption( secret_key, payload );

• Purpose: The function encrypts payload data using a secret key and returns the encrypted result.

After encryption, the expected data will be:

How to Call a Crypto Payment Gateway API

Choose Environment Options:

• stg for Sandbox.

• prod for Live.

Replace {environment} with stg or prod.

--header 'Content-Type: application/json' \

--header 'api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \

--data

Curl Explanation:

Adjust stg to prod depending on the environment you are targeting (sandbox or live).

For more API details, please have a look at the image attached below:

How To Create Webhook URL

• Webhook URL: This is the endpoint on your server (or the merchant's server) where Maxelpay will send POST requests containing data related to order status updates or other events.

Example: https://your-api-endpoint.com/api/webhooks

• https://your-api-endpoint.com would be replaced with the actual URL where your (merchant) server is hosted.

• /api/webhooks is the endpoint route where Maxelpay will send POST requests and it's created by the merchant.

• Purpose: This webhook is used for handling order status updates or payment notifications.

• HTTP Method: Specify that the method should be POST for webhook URLs.

• Data: The JSON payload (--data) includes essential information (order_id, maxelpay_txn, payment_status) related to a specific order and its payment status.

• Headers: The api-key header suggests that the endpoint might be secured with an API key for authentication.

The Content-Type header indicates that the payload is in JSON format.

Here's an example of a Curl command that shows how webhooks are structured for merchant websites:

Request Examples

curl --location 'http://your-api-endpoint.com/api/webhooks' \

--header 'api-key: xxxxxxxxxxxxxxxx' \

--header 'Content-Type: application/json' \

--data '{ "order_id" : "123", "maxelpay_txn" : "123", "payment_status" : "completed" }'

Note: The merchant must create a webhook URL or REST API exactly as shown in the example above, including the same headers (api-key and Content-Type) and data structure (order_id, maxelpay_txn, payment_status).

Explanation

1. --location: This describes curl to follow any HTTP redirects that the server sends as responses. Using this, merchants can receive immediate updates about payment notifications in real-time.

2. 'http://your-api-endpoint/api/webhooks': This is the URL to which the POST request is sent. This webhook is intended to handle requests related to order status updates.

3. --header 'api-key: xxxxxxxxxxxxxxxxx': Sets an HTTP header with key api-key and value xxxxxxxxxxxxxxxxx'. This is likely used for authentication or authorization purposes. The actual value (xxxxxxxxxxxxxxxxx') would typically be replaced with an API key.

4. --header 'Content-Type: application/json': Specifies that the content being sent in the request body (--data) is in JSON format.

5. --data '{ "order_id":"123", "maxelpay_txn":"123", "payment_status":"completed" }': This is the JSON payload data that is sent as the body of the POST request. It contains information related to the order status update:

   • "order_id": "123": Identifier of the order and its value sent by MaxelPay.

   • "maxelpay_txn": "MX-123": Transaction identifier related to the payment and its value sent by MaxelPay.

   • "payment_status": "completed": Status of the payment sent by MaxelPay.

Updating the Webhook url on the MaxelPay dashboard

• Go to the Developers section and click on "Add Webhook."

• Enter your webhook URL and click "Save."

• After you successfully add it, your webhook URL will appear under Hosted Webhooks.

And just like that, you've successfully finished the integration and webhook setup process, and you're ready to start receiving payments. Enjoy accepting cryptocurrencies with ease!

Get Free Support For API Integration

If you need assistance integrating APIs into your website, receive 24/7 Free developer support.

Contact us