Python

pip install nowgate

The SDK needs Python 3.10 or later and nothing outside the standard library. It is fully typed (py.typed): every result is a TypedDict, checked by mypy and your editor.

Configure#

client = Nowgate(api_key=env("NOWGATE_API_KEY"), base_url=base_url, transport=counted)

Every method also takes timeout= and max_retries=, and every POST idempotency_key=.

Calls#

Body fields and query parameters are keyword arguments with the API's own names, so a misspelt field fails at the call. Path IDs come first.

payment = client.payments.create(
    network="tron",
    asset="USDT",
    amount="25.00",
    order_id="1042",
    idempotency_key=order_key,
)

To read the status, the headers and the request's ID too, make the same call through client.with_response:

again = client.with_response.payments.create(
    network="tron",
    asset="USDT",
    amount="25.00",
    order_id="1042",
    idempotency_key=order_key,
)

Errors#

try:
    client.payments.create(network="tron", asset="USDT", amount="25.0000001")
except InvalidRequestError as err:
    # err.code is "amount_too_precise"; each field's problem has its JSON pointer
    pointer = err.errors[0]["pointer"]
    check(err.code == "amount_too_precise", err.code)

The exceptions are NowgateError, ApiError and its classes by status (AuthenticationError, PermissionDeniedError, NotFoundError, ConflictError, InvalidRequestError, RateLimitError, ServerError), APIConnectionError when there's no answer, and SignatureVerificationError. See Errors.

Pages#

every = [payment["id"] for payment in client.payments.list_all()]

list_all is a generator: it fetches nothing until you iterate, and stops when you do.

Amounts#

Amount fields take a decimal string, an int or a finite decimal.Decimal. A float is refused with a TypeError before anything is sent. Amounts.to_units, Amounts.from_units and Amounts.compare convert and compare amounts exactly. See Amounts.

Webhooks#

body = self.rfile.read(int(self.headers["Content-Length"]))  # the raw body, exactly as received
signature = self.headers["Nowgate-Signature"]
try:
    event = Webhook.construct_event(body, signature, secret)
except SignatureVerificationError:
    self.send_response(400)
    self.end_headers()
    return

Webhook.verify_signature and Webhook.construct_event take the raw body as bytes or str: in Flask, request.get_data(); in Django, request.body. See Webhooks.

Your own HTTP client#

A transport is a function from a nowgate.Request to a nowgate.Response. When there's no answer, it raises an OSError (such as ConnectionError or TimeoutError), which the client retries:

def counted(request: Request) -> Response:
    global requests
    requests += 1
    return urllib(request)  # or any HTTP client: raise an OSError when there's no answer