greencryptopay-py 1.0.0

This library provides convenient methods for interacting with the Greencryptopay API

Greencryptopay library for Python

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

Installation

You can install this package using pip:

pip install greencryptopay-py

Dependencies

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

Standard API

• Standard API

Getting Started:

from greencryptopay_py import Api

# Standard API
standard_api = Api.standard()

# Standard API testnet
standard_api = Api.standard(True)

# Sign up
if not merchant_id or not secret_key:
    data = standard_api.merchant('percent', 'https://example.com/callback')
    merchant_id = data['merchant_id']
    secret_key = data['secret_key']

standard_api.set_merchant_id(merchant_id)
standard_api.set_secret_key(secret_key)

Sign up:

Name	Parameters	Validation	Description
merchant	str fee_type str callback_url	Enum: [percent, fix] Max: 200	Fee type URL to send notifications about payments

Operations:

Name	Parameters	Validation	Description
payment_address	str currency str callback_url str orderId str currencyFrom str amountFrom	Enum: [btc] Max: 200 Max: 50 Enum: [usd] —	Currency URL to send notifications about payments Order identifier in your system Currency to convert from Amount to convert
withdraw	str currency array recipients	Enum: [btc] —	Currency Array structure: [['address' => 'Recipient address', 'amount' => 'Recipient's amount']]
withdraw_all	str currency str recipientAddress	Enum: [btc] —	Currency Recipient address

Stats:

Name	Parameters	Validation	Description
merchant_state	str currency	Enum: [btc]	Currency
merchant_payment_address	str currency str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none 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
merchant_incoming_payments	str currency str / none payment_address str / none txid str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none 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
merchant_withdrawals	str currency str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none order	Enum: [btc] Timestamp in UTC Timestamp in UTC Min:1, Max:200 Min:1 Enum: [asc, desc]	Currency Withdrawal 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
payment_address_callbacks	str currency str payment_address str / none txid str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none 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
payment_address_state	str currency str payment_address	Enum: [btc] —	Currency Payment address

Transfer API

• Transfer API

Getting Started:

from greencryptopay_py import Api

# Transfer API
transfer_api = Api.transfer()

# Transfer API testnet
transfer_api = Api.transfer(True)

# Sign up
if not merchant_id or not secret_key:
    data = transfer_api.merchant('percent', 'https://example.com/callback')
    merchant_id = data['merchant_id']
    secret_key = data['secret_key']

transfer_api.set_merchant_id(merchant_id)
transfer_api.set_secret_key(secret_key)

Sign up:

Name	Parameters	Validation	Description
merchant	str fee_type str callback_url	Enum: [percent, fix] Max: 200	Fee type URL to send notifications about payments

Operations:

Name	Parameters	Validation	Description
payment_address	str currency str recipientAddress str fee_type str callback_url str orderId str currencyFrom str 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:

Name	Parameters	Validation	Description
payment_address_state	str currency str payment_address	Enum: [btc] —	Currency Show only payments to specific payment address
payment_address_payments	str currency str payment_address str / none txid str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none 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
payment_address_callbacks	str currency str payment_address str / none txid str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none 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
merchant_state	str currency	Enum: [btc]	Currency
merchant_payment_address	str currency str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none 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
merchant_payments	str currency str / none txid str / none from_timestamp str / none to_timestamp int / none limit int / none page str / none 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