Skip to content

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

MIT license Six SDKs version 1.0.4

NOWPayments SDKs

Unofficial client libraries for the NOWPayments cryptocurrency payment API.
Payments, invoices, payouts, subscriptions, custody, and IPN webhooks — one monorepo, six languages.

Packages · Features · Documentation · Development · Contributing


Packages

Language Package Path Install
Node.js / TypeScript nowpayments-node packages/node npm install nowpayments-node
Python nowpayments-py packages/python pip install nowpayments-py
PHP foisalislambd/nowpayments-php packages/php composer require foisalislambd/nowpayments-php
Go github.com/foisalislambd/nowpayments-go packages/go go get github.com/foisalislambd/nowpayments-go
Ruby nowpayments-ruby packages/ruby gem install nowpayments-ruby
Rust nowpayments-rust packages/rust cargo add nowpayments-rust

Each package has its own README, examples, and publish metadata. Shared API docs live once, at the repository root.

Features

Area What you can do
Payments Create a payment, check status, list payments, update the estimate
Invoices Create an invoice and send the customer to the hosted page
Payouts Mass payout, 2FA verify, cancel a scheduled payout, fiat payouts
Subscriptions Plans, recurring payments, cancellation
Custody Sub-partners, transfers, deposits, write-offs
Conversions Convert balances held in custody
IPN Verify webhook signatures with HMAC-SHA512
Helpers Status labels and “is this payment finished?” checks

API keys come from the NOWPayments dashboard. Use the sandbox base URL while you are testing.

Documentation

Document What it covers
docs/README.md Where to start
docs/FULL_API_REFERENCE.md Endpoints collected from the Postman exports
docs/API_DOCUMENTATION.md Payments, auth, and IPN notes
docs/METHODS_CHECKLIST.md API route mapped to SDK methods

Official NOWPayments references:

Development

.
├── docs/            Shared API reference
├── packages/
│   ├── node/
│   ├── python/
│   ├── php/
│   ├── go/
│   ├── ruby/
│   └── rust/
├── scripts/         Doc generation and endpoint parity check
├── CONTRIBUTING.md
├── LICENSE
└── README.md
cd packages/node && npm install && npm run build
cd packages/python && pip install -e .
cd packages/php && composer install
cd packages/go && go test ./...
cd packages/ruby && bundle install
cd packages/rust && cargo test

Rebuild the full API reference from the raw Postman exports, then compare endpoint coverage across SDKs:

python scripts/format_api_docs.py
python scripts/verify_sdk_parity.py

Releases

The version for every SDK is in VERSION.md. Push a higher version to main. After CI passes, GitHub creates tag vX.Y.Z and publishes npm, PyPI, crates.io, and RubyGems with Trusted Publishing. Packagist and the Go module are published with a git tag, because those registries do not accept a Trusted Publisher upload from this monorepo.

Contributing

Issues and pull requests are welcome. Read CONTRIBUTING.md before you open one.

License

MIT © Foisalislambd

NOWPayments is a trademark of its owner. This repository is an independent client SDK and is not affiliated with NOWPayments.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages