https://github.com/matm/go-nowpayments

Go library for the crypto NOWPayments API
https://github.com/matm/go-nowpayments

Last synced: 9 months ago
JSON representation

Go library for the crypto NOWPayments API

Host: GitHub
URL: https://github.com/matm/go-nowpayments
Owner: matm
License: bsd-3-clause
Created: 2022-10-25T12:58:01.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-01-24T13:02:29.000Z (almost 3 years ago)
Last Synced: 2024-07-30T20:43:01.531Z (over 1 year ago)
Language: Go
Size: 45.9 KB
Stars: 3
Watchers: 1
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-go-plus - go-nowpayments - Library for the crypto NOWPayments API. ![stars](https://img.shields.io/badge/stars-3-blue) (Financial / Search and Analytic Databases)
awesome-go-cn - go-nowpayments - nowpayments) (金融 / 检索及分析资料库)
awesome-go - go-nowpayments - Library for the crypto NOWPayments API. (Financial / Search and Analytic Databases)
awesome-go-with-stars - go-nowpayments - Library for the crypto NOWPayments API. (Financial / Search and Analytic Databases)
fucking-awesome-go - go-nowpayments - Library for the crypto NOWPayments API. (Financial / Search and Analytic Databases)
awesome-go-cn - go-nowpayments - nowpayments) (金融 / 检索及分析资料库)
awesome-go - go-nowpayments - Library for the crypto NOWPayments API. (Financial / Search and Analytic Databases)
awesome-go - go-nowpayments - Library for the crypto NOWPayments API. (Financial / Search and Analytic Databases)
awesome-go - go-nowpayments - Library for the crypto NOWPayments API. (Financial / Search and Analytic Databases)

README

          # NOWPayments Go Library

[![Go Reference](https://pkg.go.dev/badge/github.com/matm/go-nowpayments.svg)](https://pkg.go.dev/github.com/matm/go-nowpayments)

[![Go Report Card](https://goreportcard.com/badge/github.com/matm/go-nowpayments)](https://goreportcard.com/report/github.com/matm/go-nowpayments)

[![codecov](https://codecov.io/gh/matm/go-nowpayments/branch/main/graph/badge.svg?token=AP16BAZR68)](https://codecov.io/gh/matm/go-nowpayments)

This is an unofficial Go library for the [crypto NOWPayments API](https://documenter.getpostman.com/view/7907941/S1a32n38#84c51632-01ad-49c0-96f8-fb4b5ad2b24a) version 1.

Note that the current implementation mostly focuses on the payments API for now:

Topic|Endpoint|Package.Method|Implemented

---|:---|:---|:---:

[Recurring payments](https://documenter.getpostman.com/view/7907941/S1a32n38#689df54e-9f43-42b3-bfe8-9bcca0444a6a)|||No

[Billing (sub-partner)](https://documenter.getpostman.com/view/7907941/S1a32n38#a523b89b-40b7-4afe-b940-043d434a6c80)|||No

[Payments](https://documenter.getpostman.com/view/7907941/S1a32n38#84c51632-01ad-49c0-96f8-fb4b5ad2b24a)|||Yes

||Get estimated price|[payments.EstimatedPrice(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#EstimatedPrice)|:heavy_check_mark:

||Get the minimum payment amount|[payments.MinimumAmount(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#MinimumAmount)|:heavy_check_mark:

||Get payment status|[payments.Status()](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#Status)|:heavy_check_mark:

||Get list of payments|[payments.List(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#List)|:heavy_check_mark:

||Get/Update payment estimate|[payments.RefreshEstimatedPrice(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#RefreshEstimatedPrice)|:heavy_check_mark:

||Create invoice|[payments.NewInvoice(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#NewInvoice)|:heavy_check_mark:

||Create payment|[payments.New(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#New)|:heavy_check_mark:

||Create payment from invoice|[payments.NewFromInvoice(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/payments#NewFromInvoice)|:heavy_check_mark:

[Currencies](https://documenter.getpostman.com/view/7907941/S1a32n38#cb80ccdc-8f7c-426c-89df-1ed2241954a5)|||Yes

||Get available currencies|[currencies.All()](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/currencies#All)|:heavy_check_mark:

||Get available checked currencies|[currencies.Selected()](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/currencies#Selected)|:heavy_check_mark:

[Payouts](https://documenter.getpostman.com/view/7907941/S1a32n38#138ee72b-4c4f-40d0-a565-4a1e907f4d94)|||No

[API status](https://documenter.getpostman.com/view/7907941/S1a32n38#9998079f-dcc8-4e07-9ac7-3d52f0fd733a)|||Yes

||Get API status|[core.Status()](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/core#Status)|:heavy_check_mark:

[Authentication](https://documenter.getpostman.com/view/7907941/S1a32n38#174cd8c5-5973-4be7-9213-05567f8adf27)|||Yes

||Authentication|[core.Authenticate(...)](https://pkg.go.dev/github.com/matm/go-nowpayments/pkg/core#Authenticate)|:heavy_check_mark:

## Installation

```bash

$ go get github.com/matm/go-nowpayments@v1.0.4

```

## Usage

Just load the config with all the credentials from a file or using a `Reader` then display the NOWPayments' API status and the last 2 payments

made with:

```go

package main

import (

	"fmt"

	"log"

	"strings"

	"github.com/matm/go-nowpayments/config"

	"github.com/matm/go-nowpayments/core"

	"github.com/matm/go-nowpayments/payments"

)

func main() {

      // Load sandbox's credentials.

	err := config.Load(strings.NewReader(`

{

      "server": "https://api-sandbox.nowpayments.io/v1",

      "login": "some_email@domain.tld",

      "password": "some_password",

      "apiKey": "some_api_key"

}

`))

	if err != nil {

		log.Fatal(err)

	}

	// Use the server URL defined above.

	core.UseBaseURL(core.BaseURL(config.Server()))

	// Use default HTTP client.

	core.UseClient(core.NewHTTPClient())

	st, err := core.Status()

	if err != nil {

		log.Fatal(err)

	}

	fmt.Println("API status:", st)

	const limit = 2

	ps, err := payments.List(&payments.ListOption{

		Limit: limit,

	})

	if err != nil {

		log.Fatal(err)

	}

	fmt.Printf("Last %d payments: %v\n", limit, ps)

}

```

## CLI Tool

A `np` tool is available to easily play with the payments API from the command line. Please make sure to target the sandbox API server in this case.

Can be installed with:

```bash

$ go install github.com/matm/go-nowpayments/cmd/np@latest

```

The following commands are available:

```

Usage of np:

  -a float

        pay amount for new payment/invoice (default 2)

  -c    show list of selected currencies

  -case string

        payment's case (sandbox only) (default "success")

  -debug

        turn debugging on

  -f string

        JSON config file to use

  -i    new invoice

  -l    list all payments

  -n    new payment

  -p string

        status of payment ID

  -pc string

        crypto currency to pay in (default "xmr")

  -pi string

        new payment from invoice ID

```

In order to work, `np` expects a JSON config file provided as an argument, like

```

$ np -f conf.json -c

```

to list all crypto currencies available for payments.

The JSON config file looks like

```json

{

  "server": "https://api-sandbox.nowpayments.io/v1",

  "login": "your_email_adresse",

  "password": "some_password",

  "apiKey": "the API key to use"

}

```

- `server` is the path to the API server, i.e. one of

  - sandbox: `https://api-sandbox.nowpayments.io/v1`

  - production: `https://api.nowpayments.io/v1`

- `login` and `password` are your NOWPayments credentials

- `apiKey` is one API key generated in your admin account

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/matm/go-nowpayments

Awesome Lists containing this project

README