1.0.2 • Published 9 months ago

greencryptopay-nodejs v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

Greencryptopay library for Node.js

The Greencryptopay library for Node.js allows you to easily integrate the Greencryptopay payment system into your Node.js projects. This library provides convenient methods for interacting with the Greencryptopay API.

Installation

You can install this package using npm:

npm install greencryptopay-nodejs --save

Dependencies

This package depends on the "node-fetch" library version ^2.6. If it's not already installed, it will be automatically installed when you install this library.

Standard API

Getting Started:

import Api from 'greencryptopay-nodejs';

(async () => {
    
    // Standard API
    const standardApi = Api.make('standard');
    
    // Standard API testnet
    const standardApi = Api.make('standard', true);

    // Sign up
    if (!merchantId || !secretKey) {
        const data = await standardApi.merchant('percent', 'https://example.com/callback');
        merchantId = data['merchant_id'];
        secretKey = data['secret_key'];
    }

    standardApi.setMerchantId(merchantId);
    standardApi.setSecretKey(secretKey);
    
})()

Sign up:

NameParametersValidationDescription
merchantstring feeTypestring callbackUrlEnum: percent, fixMax: 200Fee typeURL to send notifications about payments

Operations:

NameParametersValidationDescription
paymentAddressstring currencystring callbackUrl string orderId string currencyFrom string amountFromEnum: btcMax: 200 Max: 50 Enum: usd CurrencyURL to send notifications about payments Order identifier in your system Currency to convert from Amount to convert
withdraw string currency array recipients Enum: btc Currency Array structure: ['address' => 'Recipient address', 'amount' => 'Recipient's amount']
withdrawAll string currency string recipientAddress Enum: btc Currency Recipient address

Stats:

NameParametersValidationDescription
merchantState string currency Enum: btc Currency
merchantPaymentAddress string currency string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc Currency Address creation timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59")Address creation timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
merchantIncomingPayments string currency string / null paymentAddress string / null txid string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc Currency Show only payments to specific payment address Show only payments with specific transaction Payment timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59") Payment timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
merchantWithdrawals string currency string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc CurrencyWithdrawal timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59") Withdrawal timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
paymentAddressCallbacks string currency string paymentAddress string / null txid string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc Currency Payment address Show only payment callbacks with specific transaction Callback timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59") Callback timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
paymentAddressState string currency string paymentAddress Enum: btc Currency Payment address

Transfer API

Getting Started:

import Api from 'greencryptopay-nodejs';

(async () => {
    
    // Transfer API
    const transferApi = Api.make('transfer');

    // Transfer API testnet
    const transferApi = Api.make('transfer', true);

    // Sign up
    if (!merchantId) {
        const data = await transferApi.merchant();
        merchantId = data['merchant_id'];
    }

    transferApi.setMerchantId(merchantId);
    
})()

Sign up:

NameParametersValidationDescription
merchant

Operations:

NameParametersValidationDescription
paymentAddress string currency string recipientAddress string feeType string callbackUrl string orderId string currencyFrom string amountFrom Enum: btc Enum: percent, fix Max:200 Max:50 Enum: usd, rub, try, eur, zar, gbp, uah, aud, brl, pln Currency Recipient address Fee type URL to send notifications about payments Order identifier in your system Currency to convert from Amount to convert

Stats:

NameParametersValidationDescription
paymentAddressState string currency string paymentAddress Enum: btc Currency Show only payments to specific payment address
paymentAddressPayments string currency string paymentAddress string / null txid string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc Currency Payment address Show only specific transaction payments Payment timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59") Payment timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
paymentAddressCallbacks string currency string paymentAddress string / null txid string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc Currency Payment address Show only payment callbacks with specific transaction Payment timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59") Payment timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
merchantState string currency Enum: btc Currency
merchantPaymentAddress string currency string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc Currency Address creation timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59")Address creation timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
merchantPayments string currency string / null txid string / null fromTimestamp string / null toTimestamp int / null limit int / null page string / null order Enum: btc Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: asc, desc Currency Show only specific transaction payments Payment timestamp in UTC, from (inclusive, ex. "2035-12-31T15:30:59") Payment timestamp in UTC, to (inclusive, ex. "2035-12-31T15:30:59") Number of records in the response Page number Records order ascending or descending
1.0.2

9 months ago

1.0.1

9 months ago

1.0.0

9 months ago