monobank

README

go-monobank

Monobank REST API client. Supports personal(with Token) and corporate authorizations.

Usage

NOTE: Do not forget to check errors.

Public client

package main

import (
    "context"
    "fmt"

    "github.com/vtopc/go-monobank"
)

func main() {
    // Create public client.
    client := monobank.NewClient(nil)

    response, _ := client.Currency(context.Background())
    fmt.Println(response)
}

Personal client

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/vtopc/go-monobank"
)

func main() {
    token := os.Getenv("TOKEN")

    // Create authorized client.
    client := monobank.NewPersonalClient(nil).WithAuth(monobank.NewPersonalAuthorizer(token))

    response, _ := client.ClientInfo(context.Background())
    fmt.Println(response)
}

Corporate client

package main

import (
    "context"
    "fmt"

    "github.com/vtopc/go-monobank"
)

var secKey []byte // put here you private key
    
const webhook = "http://example.com/webhook"

func main() {
    // Create auth creator.
    authMaker, _ := monobank.NewCorpAuthMaker(secKey)

    // Create authorized client.
    client, _ := monobank.NewCorporateClient(nil, authMaker)

    // If the user is not authorized yet, do next:
    resp, _ := client.Auth(context.Background(), webhook, monobank.PermSt, monobank.PermPI)

    // Send `resp.AcceptURL` to the user and wait until it will authorize your client
    // in Monobank app on mobile, you will get GET request on `webhook` when it will be done.
    // See Documentation for details.
    // Store `resp.RequestID` somewhere.
    requestID := resp.RequestID

    // If user authorized already:
    response, _ := client.ClientInfo(context.Background(), requestID)
    fmt.Println(response)
}

Documentation

• Official - https://api.monobank.ua/docs/
• Unofficial - https://gist.github.com/Sominemo/64845669d6326f2f73d356f025656bdb

Similar projects

• https://github.com/shal/mono
• https://github.com/artemrys/go-monobank-api (no corporate API)

TODO

• More unit tests

Documentation

Overview

Package monobank - is MonoBank API client https://api.monobank.ua/docs/

Index

• Constants
• Variables
• type Account
• type Accounts
• type Authorizer
• type CardType
• type Client
  • func NewClient(client *http.Client) Client
  • func (c Client) Currency(ctx context.Context) (Currencies, error)
  • func (c *Client) WithBaseURL(uri string)
• type ClientInfo
• type CommonAPI
• type CorpAuth
  • func (a CorpAuth) SetAuth(r *http.Request) error
• type CorpAuthMaker
  • func NewCorpAuthMaker(secKey []byte) (*CorpAuthMaker, error)
  • func (c *CorpAuthMaker) New(requestID string) Authorizer
  • func (c *CorpAuthMaker) NewPermissions(permissions ...string) Authorizer
• type CorpAuthMakerAPI
• type CorporateAPI
• type CorporateClient
  • func NewCorporateClient(client *http.Client, authMaker CorpAuthMakerAPI) (CorporateClient, error)
  • func (c CorporateClient) Auth(ctx context.Context, callbackURL string, permissions ...string) (*TokenRequest, error)
  • func (c CorporateClient) CheckAuth(ctx context.Context, requestID string) error
  • func (c CorporateClient) ClientInfo(ctx context.Context, requestID string) (*ClientInfo, error)
  • func (c CorporateClient) SetWebHook(ctx context.Context, uri string) error
  • func (c CorporateClient) Transactions(ctx context.Context, requestID, accountID string, from, to time.Time) (Transactions, error)
• type Currencies
• type Currency
• type PersAuth
  • func NewPersonalAuthorizer(token string) PersAuth
  • func (a PersAuth) SetAuth(req *http.Request) error
• type PersonalAPI
• type PersonalClient
  • func NewPersonalClient(client *http.Client) PersonalClient
  • func (c PersonalClient) ClientInfo(ctx context.Context) (*ClientInfo, error)
  • func (c PersonalClient) SetWebHook(ctx context.Context, uri string) error
  • func (c PersonalClient) Transactions(ctx context.Context, accountID string, from, to time.Time) (Transactions, error)
  • func (c PersonalClient) WithAuth(auth Authorizer) PersonalClient
• type PublicAPI
• type PublicAuthorizer
  • func NewPublicAuthorizer() PublicAuthorizer
  • func (a PublicAuthorizer) SetAuth(_ *http.Request) error
• type TokenRequest
• type Transaction
• type Transactions
• type WebHookData
• type WebHookRequest
• type WebHookResponse

Constants

const (
	// PermSt - statements(transactions) and client info of individual(фізичної особи).
	PermSt = "s"
	// PermPI - personal information(first and last names).
	PermPI = "p"
	// PermFOP - statements(transactions) and client info of private entrepreneur(ФОП).
	PermFOP = "f"
)

Permissions.

Variables

var (
	ErrDecodePrivateKey  = errors.New("failed to decode private key")
	ErrEncodePublicKey   = errors.New("failed to encode public key with sha1")
	ErrNoPrivateKey      = errors.New("failed to find private key block")
	ErrInvalidEC         = errors.New("invalid elliptic curve private key value")
	ErrInvalidPrivateKey = errors.New("invalid private key length")
)

Errors.

var ErrEmptyAuthMaker = errors.New("authMaker is nil")

var ErrEmptyRequest = errors.New("empty request")

Types

type Account

type Account struct {
	AccountID    string   `json:"id"`
	Balance      int64    `json:"balance"`
	CreditLimit  int64    `json:"creditLimit"`
	CurrencyCode int      `json:"currencyCode"`
	CashbackType string   `json:"cashbackType"` // enum: None, UAH, Miles
	CardMasks    []string `json:"maskedPan"`    // card number masks
	Type         CardType `json:"type"`
	IBAN         string   `json:"iban"`
}

type Accounts

type Accounts []Account

type Authorizer

type Authorizer interface {
	// SetAuth modifies http.Request and sets authorization tokens
	SetAuth(*http.Request) error
}

type CardType

type CardType string

const (
	Black    CardType = "black"
	White    CardType = "white"
	Platinum CardType = "platinum"
	FOP      CardType = "fop"
)

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(client *http.Client) Client

NewClient - returns public monobank Client

func (Client) Currency

func (c Client) Currency(ctx context.Context) (Currencies, error)

func (*Client) WithBaseURL

func (c *Client) WithBaseURL(uri string)

WithBaseURL updates baseURL

type ClientInfo

type ClientInfo struct {
	Name       string   `json:"name"`
	WebHookURL string   `json:"webHookUrl"`
	Accounts   Accounts `json:"accounts"`
}

ClientInfo - client/user info

type CommonAPI

type CommonAPI interface {
	PublicAPI

	// SetWebHook - sets webhook for statements
	SetWebHook(ctx context.Context, uri string) error
}

type CorpAuth

type CorpAuth struct {
	*CorpAuthMaker
	// contains filtered or unexported fields
}

func (CorpAuth) SetAuth

func (a CorpAuth) SetAuth(r *http.Request) error

type CorpAuthMaker

type CorpAuthMaker struct {
	KeyID string // X-Key-Id - ID key of the service
	// contains filtered or unexported fields
}

func NewCorpAuthMaker

func NewCorpAuthMaker(secKey []byte) (*CorpAuthMaker, error)

func (*CorpAuthMaker) New

func (c *CorpAuthMaker) New(requestID string) Authorizer

New returns corp Authorizer for endpoints with Request ID.

func (*CorpAuthMaker) NewPermissions

func (c *CorpAuthMaker) NewPermissions(permissions ...string) Authorizer

NewPermissions returns corp Authorizer for Auth endpoint to get Request ID

type CorpAuthMakerAPI

type CorpAuthMakerAPI interface {
	New(requestID string) Authorizer
	NewPermissions(permissions ...string) Authorizer
}

type CorporateAPI

type CorporateAPI interface {
	CommonAPI

	// Auth initializes access.
	// https://api.monobank.ua/docs/corporate.html#operation--personal-auth-request-post
	Auth(ctx context.Context, callbackURL string, permissions ...string) (*TokenRequest, error)

	// CheckAuth checks status of request for client's personal data.
	// https://api.monobank.ua/docs/corporate.html#operation--personal-auth-request-get
	CheckAuth(ctx context.Context, requestID string) error

	// ClientInfo - https://api.monobank.ua/docs/corporate.html#operation--personal-client-info-get
	ClientInfo(ctx context.Context, requestID string) (*ClientInfo, error)

	// Transactions - gets bank account statements(transactions)
	// https://api.monobank.ua/docs/corporate.html#operation--personal-statement--account---from---to--get
	Transactions(ctx context.Context, requestID, accountID string, from, to time.Time) (Transactions, error)
}

type CorporateClient

type CorporateClient struct {
	// contains filtered or unexported fields
}

func NewCorporateClient

func NewCorporateClient(client *http.Client, authMaker CorpAuthMakerAPI) (CorporateClient, error)

NewCorporateClient returns corporate client

func (CorporateClient) Auth

func (c CorporateClient) Auth(ctx context.Context, callbackURL string, permissions ...string) (*TokenRequest, error)

Auth initializes access.

func (CorporateClient) CheckAuth

func (c CorporateClient) CheckAuth(ctx context.Context, requestID string) error

func (CorporateClient) ClientInfo

func (c CorporateClient) ClientInfo(ctx context.Context, requestID string) (*ClientInfo, error)

func (CorporateClient) SetWebHook

func (c CorporateClient) SetWebHook(ctx context.Context, uri string) error

SetWebHook sets webhook for corporate API.

func (CorporateClient) Transactions

func (c CorporateClient) Transactions(ctx context.Context, requestID, accountID string, from, to time.Time) (Transactions, error)

type Currencies

type Currencies []Currency

type Currency

type Currency struct {
	CurrencyCodeA int           `json:"currencyCodeA"`
	CurrencyCodeB int           `json:"currencyCodeB"`
	Date          epoch.Seconds `json:"date"`
	RateSell      float64       `json:"rateSell"`
	RateBuy       float64       `json:"rateBuy"`
	RateCross     float64       `json:"rateCross"`
}

type PersAuth

type PersAuth struct {
	// contains filtered or unexported fields
}

func NewPersonalAuthorizer

func NewPersonalAuthorizer(token string) PersAuth

func (PersAuth) SetAuth

func (a PersAuth) SetAuth(req *http.Request) error

type PersonalAPI

type PersonalAPI interface {
	CommonAPI

	// ClientInfo - https://api.monobank.ua/docs/#/definitions/UserInfo
	ClientInfo(context.Context) (*ClientInfo, error)

	// Transactions - gets bank account statements
	// https://api.monobank.ua/docs/#/definitions/StatementItems
	Transactions(ctx context.Context, accountID string, from, to time.Time) (Transactions, error)
}

type PersonalClient

type PersonalClient struct {
	// contains filtered or unexported fields
}

func NewPersonalClient

func NewPersonalClient(client *http.Client) PersonalClient

func (PersonalClient) ClientInfo

func (c PersonalClient) ClientInfo(ctx context.Context) (*ClientInfo, error)

func (PersonalClient) SetWebHook

func (c PersonalClient) SetWebHook(ctx context.Context, uri string) error

func (PersonalClient) Transactions

func (c PersonalClient) Transactions(ctx context.Context, accountID string, from, to time.Time) (
	Transactions, error)

TODO: make `to` optional

func (PersonalClient) WithAuth

func (c PersonalClient) WithAuth(auth Authorizer) PersonalClient

WithAuth returns copy of PersonalClient with authorizer

type PublicAPI

type PublicAPI interface {
	// Currency https://api.monobank.ua/docs/#/definitions/CurrencyInfo
	Currency(context.Context) (Currencies, error)
}

type PublicAuthorizer

type PublicAuthorizer struct{}

func NewPublicAuthorizer

func NewPublicAuthorizer() PublicAuthorizer

func (PublicAuthorizer) SetAuth

func (a PublicAuthorizer) SetAuth(_ *http.Request) error

type TokenRequest

type TokenRequest struct {
	RequestID string `json:"tokenRequestId"` // Unique token request ID.
	AcceptURL string `json:"acceptUrl"`      // URL to redirect client or build QR on top of it.
}

type Transaction

type Transaction struct {
	ID              string        `json:"id"`
	Time            epoch.Seconds `json:"time"`
	Description     string        `json:"description"`
	MCC             int32         `json:"mcc"`
	OriginalMCC     int32         `json:"originalMcc"`
	Hold            bool          `json:"hold"`
	Amount          int64         `json:"amount"`
	OperationAmount int64         `json:"operationAmount"`
	CurrencyCode    int           `json:"currencyCode"`
	CommissionRate  int64         `json:"commissionRate"`
	CashbackAmount  int64         `json:"cashbackAmount"`
	Balance         int64         `json:"balance"`
	Comment         string        `json:"comment"`
	ReceiptID       string        `json:"receiptId"`
	EDRPOU          string        `json:"counterEdrpou"`
	IBAN            string        `json:"counterIban"`
}

Transaction - bank account statement

type Transactions

type Transactions []Transaction

Transactions - transactions

type WebHookData

type WebHookData struct {
	AccountID   string      `json:"account"`
	Transaction Transaction `json:"statementItem"`
}

type WebHookRequest

type WebHookRequest struct {
	WebHookURL string `json:"webHookUrl"`
}

type WebHookResponse

type WebHookResponse struct {
	Type string      `json:"type"` // "StatementItem"
	Data WebHookData `json:"data"`
}