README.md

Coingate Python

Simple API client for the CoinGate service.

Usage

Virtualenv

You can use pipenv tool for development:

• create virtualenv: pipenv --python /path/to/python
• install dependencies: pipenv lock && pipenv install
• open virtualenv shell: pipenv shell (optional)

Latest API version

from coingate.client import CoinGateClient

The CoinGateClient class will inherit methods from the latest API's supported version client. Currently, it is API V2.

API V2

from coingate.client import CoinGateV2Client, CoinGateV2Order

# Create a client
# To use the production API, add env="live"
client = CoinGateV2Client("app_id", "api_token")

# Prepare an order
new_order = CoinGateV2Order.new(
    "order-ID",
    10.5,
    "USD",
    "USD",
    callback_url='https://api.example.com/paymentcallback?token=randomtoken',
    cancel_url='https://www.example.com/ordercancelled',
    success_url='https://www.example.com/orderprocessed')

# Create the order
placed_order = client.create_order(new_order)

# Get the payment URL:
print(placed_order.payment_url)

# List orders :
orders = list(client.iterate_all_orders())

# Get an order by id:
order = orders[0].coingate_id

API V1

from coingate.client import CoinGateV1Client, CoinGateV1Order

# Create a client
# To use the production API, add env="live"
client = CoinGateV1Client("app_id", "api_key", "api_secret")

# Prepare an order
new_order = CoinGateV1Order.new(
    "order-ID",
    10.5,
    "USD",
    "USD",
    callback_url='https://api.example.com/paymentcallback?token=randomtoken',
    cancel_url='https://www.example.com/ordercancelled',
    success_url='https://www.example.com/orderprocessed')
    
# Create the order
placed_order = client.create_order(new_order)

# Get the payment URL:
print(placed_order.payment_url)

# List orders :
orders = list(client.iterate_all_orders())

# Get an order by id:
order = orders[0].coingate_id