https://github.com/ndolestudio/smobilpay-go

Unofficial SDK for the smobilpay API
https://github.com/ndolestudio/smobilpay-go

apiclient go smobilpay

Last synced: about 1 month ago
JSON representation

Unofficial SDK for the smobilpay API

• Host: GitHub
• URL: https://github.com/ndolestudio/smobilpay-go
• Owner: NdoleStudio
• License: mit
• Created: 2022-10-08T11:33:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-25T16:48:55.000Z (about 2 months ago)
• Last Synced: 2024-11-25T17:42:10.542Z (about 2 months ago)
• Topics: apiclient, go, smobilpay
• Language: Go
• Homepage: https://apidocs.smobilpay.com/s3papi/index.html
• Size: 74.2 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Smobilpay Go SDK

[![Build](https://github.com/NdoleStudio/smobilpay-go/actions/workflows/main.yml/badge.svg)](https://github.com/NdoleStudio/smobilpay-go/actions/workflows/main.yml)

[![codecov](https://codecov.io/gh/NdoleStudio/smobilpay-go/branch/main/graph/badge.svg)](https://codecov.io/gh/NdoleStudio/smobilpay-go)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/NdoleStudio/smobilpay-go/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/NdoleStudio/smobilpay-go/?branch=main)

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

[![GitHub contributors](https://img.shields.io/github/contributors/NdoleStudio/smobilpay-go)](https://github.com/NdoleStudio/smobilpay-go/graphs/contributors)

[![GitHub license](https://img.shields.io/github/license/NdoleStudio/smobilpay-go?color=brightgreen)](https://github.com/NdoleStudio/smobilpay-go/blob/master/LICENSE)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/NdoleStudio/smobilpay-go)](https://pkg.go.dev/github.com/NdoleStudio/smobilpay-go)

This package provides an unofficial `go` client for the [Smobilpay API](https://apidocs.smobilpay.com/s3papi/index.html)

## Installation

`smobilpay-go` is compatible with modern Go releases in module mode, with Go installed:

```bash

go get github.com/NdoleStudio/smobilpay-go

```

Alternatively the same can be achieved if you use `import` in a package:

```go

import "github.com/NdoleStudio/smobilpay-go"

```

## Implemented

- **Client**

  - `GET /ping`:  API Healthcheck endpoint

  - `GET /verifytx`: Get the current collection status

  - `GET /historystd`: Get the transaction history

  - `POST /quotestd`: Initializes a transaction

  - `POST /collectstd`: Confirms a transaction

- **Bill**

  - `GET /bill`: Get details of a bill

- **Topup**

  - `GET /topup`: Get available topup packages.

- **Cashin**

  - `GET /cashin`: Get cashin pay item.

- **Cashout**

  - `GET /cashout`: Get Cashout pay item.

- **Product**

  - `GET /product`: Get product pay items.

## Usage

### Initializing the Client

An instance of the client can be created using `New()`.

```go

package main

import (

    "github.com/NdoleStudio/smobilpay-go"

)

func main()  {

    client := smobilpay.New(

        smobilpay.WithAccessToken(accessToken),

        smobilpay.WithAccessSecret(accessSecret),

    )

}

```

### Error handling

All API calls return an `error` as the last return object. All successful calls will return a `nil` error.

```go

status, response, err := client.Ping(context.Background())

if err != nil {

    //handle error

}

```

## Testing

You can run the unit tests for this client from the root directory using the command below:

```bash

go test -v

```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details