API Documents

Overview

MilaCoins provide a payment gateway and business wallet that allows merchants to automate the processes of accepting cryptocurrency payments and payouts from their customers, as well as making currency exchange transactions and receiving data on the transaction history and account balance status for reporting. developer also can call MilaCoins API directly over HTTPS using JSON requests.

Environment

In addition to the Production environment, MilaCoins also provides developers with a test environment, also known as Sandbox. The SandBox environment is exactly like the Production environment. The only difference between the Production and Sandbox environment is that the latter uses test networks (testnets).

The Sandbox Environment and the Production Environment are independent environments and are not connected to each other in any way.

Sandbox Base URL - https://sandbox-api.milacoins.com

Production Base URL - https://api.milacoins.com

Authentication

All API requests must be made over HTTPS, Please note that plain HTTP will be refused. You must include your X-headers in all requests.

The X-headers:

• X-api-key an API Key that you generate in our backoffice

• X-Sig signature of the request in the hex format (See "Signing a request" below)

• X-time number of seconds since Unix Epoch in UTC

Api Keys

• You can generate API Keys in your profile->Security->API for test and production environments.
• Secret key values are shown only once upon key creation.
• Next, you will be asked to add IP addresses that are allowed to use these keys.

Signing a request

The value of the X-Sig is generated by a sha256 HMAC algorithm with a secret key. It contains the following information:

• A timestamp (value of the X-time header in Seconds!) taken as a string
• An HTTP request method name in upper-case, GET | POST
• Endpoint (URL of the request without a host name), starting with a slash and including all query parameters, example : /transactions?from=2020-1-1&to=2022-1-1
• Request body, taken exactly as it will be sent. If there is no request body like GET requests, don't include it

Example of the string to be signed to get a signature Header Aka X-sig: 1618832932.344GET/transactions/?from=2020-1-1&to=2022-1-1

Signing Function Example

const axios = require('axios'),
baseUrl = process.env.MILACOINS_BASE_URL,
apiKey = process.env.MILACOINS_API_KEY,
secretKey = process.env.MILACOINS_SECRET_KEY;

async request(endPoint, { method = 'GET', body } = {}) {
    const options = {
        url: `${baseUrl}/${endPoint}`,
        method,
        data: body,
        headers: {}
      },
      time = Math.round(Date.now() / 1000),
      hmacSha256 = crypto.createHmac('sha256', secretKey);
    hmacSha256.update(
      time + options.method.toUpperCase()  + endPoint
    );
    if (options.data) {
      options.data = JSON.stringify(options.data);
      hmacSha256.update(Buffer.from(options.data, 'utf-8'));
    }

    options.headers.Accept = 'application/json';
    options.headers['Content-Type'] = 'application/json';
    options.headers['X-api-key'] = apiKey;
    options.headers['X-time'] = time;
    options.headers['X-Sig'] = hmacSha256.digest('hex');

    try {
      const { data } = await axios(options);
      return data;
    } catch (err) {
      if (err.response && err.response.data) throw err.response.data;
      else throw new Error('unknown error');
    }
  }

Libraries

MilaCoins maintains server-side API libraries in various programming languages that are available via popular package managers.

Node.js

To install the NPM Package, go to https://www.npmjs.com/package/milauth

Python

To install the Python Package, go to https://pypi.org/project/milauth

Postman Collection

To download the Postman collection (v2.1), click-here

For more instructions on Postman, please visit this section.

Logs

Get Http Logs

Request Query string:

Response (JSON):

Get Http Log By Id

Request Parameters (URL):

Response (JSON):

Info

Get Supported Currencies

Response (JSON):

Get Supported wallets

Response (JSON):

Transactions

Create Checkout

Request Body (JSON):

Response (JSON):

Create Widget

Request Body (JSON):

Response (JSON):

Get Invoices

Request Query string:

Response (JSON):

Get Invoice By Id

Request Parameters (URL):

Response (JSON):

Errors

MilaCoins API uses HTTP status to indicate the success or failure responses. Status that bigger then 400 will indicate has error.

Error response example:

{
  "requestID": "62d956eda0a3bf0730f5fd18",
  "name": "DOCUMENT_NOT_FOUND",
  "message": "No Invoice found with that ID (id:62d8df9142d15eaa837f8ace)",
  "code": 1604
}

Errors list:

Postman

Postman is an API Collaboration Platform.

MilaCoins now offers Postman Collection for quick and easy usage of our REST APIs.

How to import Collection

• Download the Collection. (click-here)
• Import the Collection into the Postman app.

How to use Postman

• Open the Postman app.

• Click the Import button.

  

• On the MilaCoins-API on the left side-bar. When it’s open, in Variables you'll need to set:

• apiBaseUrl Production / Sandbox environment.

• api-key generated from your profile.

• secret-key generated from your profile.