PaymentsApi.md

MinergateApi.PaymentsApi

All URIs are relative to https://api.minergate.com/1.0

Method	HTTP request	Description
getInvoiceById	GET /invoices/{INVOICE_ID}	Invoices by Id
getInvoices	GET /invoices	Invoices

getInvoiceById

getInvoiceById(INVOICE_ID)

Invoices by Id

Returns the specified invoice. Requires authorization.

Example

var MinergateApi = require('minergate_api');
var defaultClient = MinergateApi.ApiClient.default;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix = 'Token';

var apiInstance = new MinergateApi.PaymentsApi();

var INVOICE_ID = "INVOICE_ID_example"; // String | Id of Invoice


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getInvoiceById(INVOICE_ID, callback);

Parameters

Name	Type	Description	Notes
INVOICE_ID	String	Id of Invoice

Return type

null (empty response body)

Authorization

token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getInvoices

getInvoices()

Invoices

Returns the list of user's invoices. Requires authorization.

Example

var MinergateApi = require('minergate_api');
var defaultClient = MinergateApi.ApiClient.default;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix = 'Token';

var apiInstance = new MinergateApi.PaymentsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getInvoices(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json