monobank

package module

v0.2303.1 Latest Latest Go to latest Published: May 12, 2024 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitea.stuzer.link/stuzer05/go-monobank

Links

Open Source Insights

README ¶

Go API client for swagger

API для отримання інформації про виписки та стан особистого рахунку та рахунків ФОП. Для надання доступу потрібно пройти авторизацію у особистому кабінеті https://api.monobank.ua/ та отримати токен для персонального використання. Якщо у вас є запитання щодо роботи API, запрошуємо до ком'юніті у Telegram-групі. API недоступне для клієнтів до 16 років, дані за дитячими рахунками доступні з батьківського акаунту. Якщо у вас є сервіс і ви хочете централізовано приєднатися до API для надання послуг клієнтам, потрібно підключитися до API для провайдерів послуг, що має більше можливостей. Якщо дані клієнтів не будуть надходити на ваші сервери або ви робите сервіс для своєї родини, використання корпоративного API необов'язкове. Розробка бібліотек або програм, які будуть використовувати клієнти особисто (дані клієнта не будуть проходити черeз вузли розробника), також не потребують використання корпоративного API. Це надасть змогу клієнтам monobank авторизуватись у вашому сервісі (наприклад, у фінансовому менеджері) для надання інформації про стан рахунку або виписки. У разі виявлення експлуатації цього API в якості корпоративного, банк залишає за собою право накласти санкції на компанію.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: v2303
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://api.monobank.ua

Class	Method	HTTP request	Description
_Api	BankCurrencyGet	Get /bank/currency	Отримання курсів валют
_Api	PersonalClientInfoGet	Get /personal/client-info	Інформація про клієнта
_Api	PersonalStatementAccountFromToGet	Get /personal/statement/{account}/{from}/{to}	Виписка
_Api	PersonalWebhookPost	Post /personal/webhook	Встановлення WebHook

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* Monobank open API * * API для отримання інформації про виписки та стан особистого рахунку та рахунків ФОП. Для надання доступу потрібно пройти авторизацію у особистому кабінеті https://api.monobank.ua/ та отримати токен для персонального використання. Якщо у вас є запитання щодо роботи API, запрошуємо до ком'юніті у [Telegram-групі](https://t.me/joinchat/FiAEWhDf-QzTqM4wzEtffw). API недоступне для клієнтів до 16 років, дані за дитячими рахунками доступні з батьківського акаунту. Якщо у вас є сервіс і ви хочете централізовано приєднатися до API для надання послуг клієнтам, потрібно підключитися до [API для провайдерів послуг](/docs/corporate.html), що має більше можливостей. Якщо дані клієнтів не будуть надходити на ваші сервери або ви робите сервіс для своєї родини, використання корпоративного API необов'язкове. Розробка бібліотек або програм, які будуть використовувати клієнти особисто (дані клієнта не будуть проходити черeз вузли розробника), також не потребують використання корпоративного API. Це надасть змогу клієнтам monobank авторизуватись у вашому сервісі (наприклад, у фінансовому менеджері) для надання інформації про стан рахунку або виписки. У разі виявлення експлуатації цього API в якості корпоративного, банк залишає за собою право накласти санкції на компанію. * * API version: v2303 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type ApiService
- func (a *ApiService) BankCurrencyGet(ctx context.Context) ([]CurrencyInfoInner, *http.Response, error)
- func (a *ApiService) PersonalClientInfoGet(ctx context.Context, xToken string) (UserInfo, *http.Response, error)
- func (a *ApiService) PersonalStatementAccountFromToGet(ctx context.Context, xToken string, account string, from string, to string) ([]StatementItemsInner, *http.Response, error)
- func (a *ApiService) PersonalWebhookPost(ctx context.Context, body SetWebHook, xToken string) (*http.Response, error)
type Array
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type CurrencyInfoInner
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type ModelError
type SetWebHook
type StatementItemsInner
type UserInfo
type UserInfoAccounts
type UserInfoJars
type WebHookResponse
type WebHookResponseData

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	Api *ApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Monobank open API API vv2303 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶ added in v0.2303.1

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type ApiService ¶ added in v0.2303.1

type ApiService service

func (*ApiService) BankCurrencyGet ¶ added in v0.2303.1

func (a *ApiService) BankCurrencyGet(ctx context.Context) ([]CurrencyInfoInner, *http.Response, error)

ApiService Отримання курсів валют Отримати базовий перелік курсів валют monobank. Інформація кешується та оновлюється не частіше 1 разу на 5 хвилин.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CurrencyInfoInner

func (*ApiService) PersonalClientInfoGet ¶ added in v0.2303.1

func (a *ApiService) PersonalClientInfoGet(ctx context.Context, xToken string) (UserInfo, *http.Response, error)

ApiService Інформація про клієнта Отримання інформації про клієнта та переліку його рахунків і банок. Обмеження на використання функції не частіше ніж 1 раз у 60 секунд.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param xToken Token для особистого доступу до API

@return UserInfo

func (*ApiService) PersonalStatementAccountFromToGet ¶ added in v0.2303.1

func (a *ApiService) PersonalStatementAccountFromToGet(ctx context.Context, xToken string, account string, from string, to string) ([]StatementItemsInner, *http.Response, error)

ApiService Виписка Отримання виписки за час від {from} до {to} часу в секундах в форматі Unix time. Максимальний час, за який можливо отримати виписку — 31 доба + 1 година (2682000 секунд). Обмеження на використання функції — не частіше ніж 1 раз на 60 секунд. Повертає 500 транзакцій з кінця, тобто від часу to до from. Якщо кількість транзакцій = 500, потрібно зробити ще один запит, зменшивши час to до часу останнього платежу, з відповіді. Якщо знову кількість транзакцій = 500, то виконуєте запити до того часу, поки кількість транзакцій не буде < 500. Відповідно, якщо кількість транзакцій < 500, то вже отримано всі платежі за вказаний період.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param xToken Token для особистого доступу до API
@param account Ідентифікатор рахунку або банки з переліків Statement list або 0 - дефолтний рахунок.
@param from Початок часу виписки.
@param to Останній час виписки (якщо відсутній, буде використовуватись поточний час).

@return []StatementItemsInner

func (*ApiService) PersonalWebhookPost ¶ added in v0.2303.1

func (a *ApiService) PersonalWebhookPost(ctx context.Context, body SetWebHook, xToken string) (*http.Response, error)

ApiService Встановлення WebHook Встановлення URL користувача: - Для підтвердження коректності наданої адреси, на неї надсилається GET-запит. Сервер має відповісти строго HTTP статус-кодом 200, і ніяким іншим. Якщо валідацію пройдено, на задану адресу починають надсилатися POST запити з подіями. - Події надсилаються у наступному вигляді: POST запит на задану адресу у форматі `{type:\"StatementItem\", data:{account:\"...\", statementItem:{#StatementItem}}}`. Якщо сервіс користувача не відповість протягом 5с на команду, сервіс повторить спробу ще через 60 та 600 секунд. Якщо на третю спробу відповідь отримана не буде, функція буде вимкнута. Відповідь сервера має строго містити HTTP статус-код 200.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param xToken Token для особистого доступу до API

type Array ¶

type Array []string

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type CurrencyInfoInner ¶

type CurrencyInfoInner struct {
	// Код валюти рахунку відповідно ISO 4217
	CurrencyCodeA float64 `json:"currencyCodeA,omitempty"`
	// Код валюти рахунку відповідно ISO 4217
	CurrencyCodeB float64 `json:"currencyCodeB,omitempty"`
	// Час курсу в секундах в форматі Unix time
	Date      float64 `json:"date,omitempty"`
	RateSell  float32 `json:"rateSell,omitempty"`
	RateBuy   float32 `json:"rateBuy,omitempty"`
	RateCross float32 `json:"rateCross,omitempty"`
}

type GenericSwaggerError ¶ added in v0.2303.1

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶ added in v0.2303.1

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶ added in v0.2303.1

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶ added in v0.2303.1

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ModelError ¶ added in v0.2303.1

type ModelError struct {
	// Текст помилки для кінцевого користувача, для автоматичного оброблення потрібно аналізувати HTTP код відповіді (200, 404, 429 та інші)
	ErrorDescription string `json:"errorDescription,omitempty"`
}

type SetWebHook ¶

type SetWebHook struct {
	WebHookUrl string `json:"webHookUrl,omitempty"`
}

URL для надсиляння подій по зміні балансу рахунків фізичних осіб, ФОП та банок

type StatementItemsInner ¶

type StatementItemsInner struct {
	// Унікальний id транзакції
	Id string `json:"id,omitempty"`
	// Час транзакції в секундах в форматі Unix time
	Time float64 `json:"time,omitempty"`
	// Опис транзакцій
	Description string `json:"description,omitempty"`
	// Код типу транзакції (Merchant Category Code), відповідно ISO 18245
	Mcc float64 `json:"mcc,omitempty"`
	// Оригінальний код типу транзакції (Merchant Category Code), відповідно ISO 18245
	OriginalMcc float64 `json:"originalMcc,omitempty"`
	// Статус блокування суми (детальніше у [wiki](https://en.wikipedia.org/wiki/Authorization_hold))
	Hold bool `json:"hold,omitempty"`
	// Сума у валюті рахунку в мінімальних одиницях валюти (копійках, центах)
	Amount float64 `json:"amount,omitempty"`
	// Сума у валюті транзакції в мінімальних одиницях валюти (копійках, центах)
	OperationAmount float64 `json:"operationAmount,omitempty"`
	// Код валюти рахунку відповідно ISO 4217
	CurrencyCode float64 `json:"currencyCode,omitempty"`
	// Розмір комісії в мінімальних одиницях валюти (копійках, центах)
	CommissionRate float64 `json:"commissionRate,omitempty"`
	// Розмір кешбеку в мінімальних одиницях валюти (копійках, центах)
	CashbackAmount float64 `json:"cashbackAmount,omitempty"`
	// Баланс рахунку в мінімальних одиницях валюти (копійках, центах)
	Balance float64 `json:"balance,omitempty"`
	// Коментар до переказу, уведений користувачем. Якщо не вказаний, поле буде відсутнім
	Comment string `json:"comment,omitempty"`
	// Номер квитанції для check.gov.ua. Поле може бути відсутнім
	ReceiptId string `json:"receiptId,omitempty"`
	// Номер квитанції ФОПа, приходить у випадку якщо це операція із зарахуванням коштів
	InvoiceId string `json:"invoiceId,omitempty"`
	// ЄДРПОУ контрагента, присутній лише для елементів виписки рахунків ФОП
	CounterEdrpou string `json:"counterEdrpou,omitempty"`
	// IBAN контрагента, присутній лише для елементів виписки рахунків ФОП
	CounterIban string `json:"counterIban,omitempty"`
	// Найменування контрагента
	CounterName string `json:"counterName,omitempty"`
}

type UserInfo ¶

type UserInfo struct {
	// Ідентифікатор клієнта (збігається з id для send.monobank.ua)
	ClientId string `json:"clientId,omitempty"`
	// Ім'я клієнта
	Name string `json:"name,omitempty"`
	// URL для надсиляння подій по зміні балансу рахунку
	WebHookUrl string `json:"webHookUrl,omitempty"`
	// Перелік прав, які які надає сервіс (1 літера на 1 permission).
	Permissions string `json:"permissions,omitempty"`
	// Перелік доступних рахунків
	Accounts []UserInfoAccounts `json:"accounts,omitempty"`
	// Перелік банок
	Jars []UserInfoJars `json:"jars,omitempty"`
}

Опис клієнта та його рахунків і банок.

type UserInfoAccounts ¶ added in v0.2303.1

type UserInfoAccounts struct {
	// Ідентифікатор рахунку
	Id string `json:"id,omitempty"`
	// Ідентифікатор для сервісу https://send.monobank.ua/{sendId}
	SendId string `json:"sendId,omitempty"`
	// Баланс рахунку в мінімальних одиницях валюти (копійках, центах)
	Balance float64 `json:"balance,omitempty"`
	// Кредитний ліміт
	CreditLimit float64 `json:"creditLimit,omitempty"`
	// Тип рахунку
	Type_ string `json:"type,omitempty"`
	// Код валюти рахунку відповідно ISO 4217
	CurrencyCode float64 `json:"currencyCode,omitempty"`
	// Тип кешбеку який нараховується на рахунок
	CashbackType string `json:"cashbackType,omitempty"`
	// Перелік замаскованних номерів карт (більше одного може бути у преміальних карт)
	MaskedPan *Array `json:"maskedPan,omitempty"`
	// IBAN рахунку
	Iban string `json:"iban,omitempty"`
}

type UserInfoJars ¶ added in v0.2303.1

type UserInfoJars struct {
	// Ідентифікатор банки
	Id string `json:"id,omitempty"`
	// Ідентифікатор для сервісу https://send.monobank.ua/{sendId}
	SendId string `json:"sendId,omitempty"`
	// Назва банки
	Title string `json:"title,omitempty"`
	// Опис банки
	Description string `json:"description,omitempty"`
	// Код валюти банки відповідно ISO 4217
	CurrencyCode float64 `json:"currencyCode,omitempty"`
	// Баланс банки в мінімальних одиницях валюти (копійках, центах)
	Balance float64 `json:"balance,omitempty"`
	// Цільова сума для накопичення в банці в мінімальних одиницях валюти (копійках, центах)
	Goal float64 `json:"goal,omitempty"`
}

type WebHookResponse ¶

type WebHookResponse struct {
	Type string // "StatementItem"
	Data WebHookResponseData
}

type WebHookResponseData ¶

type WebHookResponseData struct {
	Account       string
	StatementItem StatementItemsInner
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL