Git Product home page Git Product logo

monobank-open-api-documentation's Introduction

Monobank Open API (v2303)

Disclaimer

This API documentation is not affiliated with Monobank. It was created independently to contribute to the Monobank development community. The author of this documentation is not affiliated with Monobank in any way and just wants to contribute, making API more accessible and convinient for everyone.

Original API Documentation from the Developer

Access the official Monobank API documentation here: Monobank API Documentation

Postman Collection (Recommended)

https://documenter.getpostman.com/view/25272928/2sA3JGe3W4

Overview

Monobank Open API provides access to account statements and the status of personal and sole proprietorship accounts. This API is designed to facilitate the integration of Monobank's banking services into your applications, providing capabilities such as retrieving exchange rates, client information, transaction statements, and setting up webhook subscriptions. This API is not available to clients under 16 years of age. Information on children's accounts is accessible from the parent's account. The bank reserves the right to impose sanctions if misuse of the API is detected.

Features

  • Exchange Rates: Get the latest currency exchange rates.
  • Client Information: Retrieve detailed information about clients, including account and bank details.
  • Transaction Statements: Access detailed transaction history for specified periods.
  • Webhook Subscriptions: Set up webhooks to receive real-time transaction notifications.

Prerequisites

To use this API, you need to:

  • Have a Monobank account.
  • Obtain an API access token by logging into your personal account at Monobank API Portal.

Getting Started

To get started with the Monobank Open API, follow these steps:

  1. Ensure you have a Monobank account.
  2. Log in to your account at https://api.monobank.ua/ and navigate to the API section to obtain your personal API token.
  3. Use the token as the X-Token header for all your requests to the API.

API Usage

Exchange Rates

  • Endpoint: GET /bank/currency
  • Description: Retrieves basic currency exchange rates. Data is cached and updated every 5 minutes.
  • Example Request:
    curl -X GET "{{BASE_URL}}/bank/currency" -H "Content-Type: application/json"

Client Information

  • Endpoint: GET /personal/client-info
  • Required: X-Token header for authentication.
  • Description: Fetches information about the client, including accounts and associated banks. Can be called no more than once every 60 seconds.
  • Example Request:
    curl -X GET "{{BASE_URL}}/personal/client-info" -H "X-Token: your_access_token"

Transaction Statements

  • Endpoint: GET /personal/statement/{account}/{from}/{to}
  • Required: X-Token header for authentication.
  • Description: Retrieves transaction statements for a specified period. The maximum period retrievable is 31 days plus 1 hour.
  • Example Request:
    curl -X GET "{{BASE_URL}}/personal/statement/{account}/{from}/{to}" -H "X-Token: your_access_token"

Webhook Subscription

  • Endpoint: POST /personal/webhook
  • Required: X-Token header for authentication.
  • Description: Subscribes a webhook URL to receive real-time notifications about transactions. The server must respond with an HTTP status code of 200 to confirm the validity of the provided address.
  • Example Request:
    curl -X POST "{{BASE_URL}}/personal/webhook" \
         -H "X-Token: your_access_token" \
         -H "Content-Type: application/json" \
         -d '{"webHookUrl": "https://yourdomain.com/webhook"}'

Support and Community

If you have questions about the API or encounter any issues, you are encouraged to join the Monobank community on Telegram. Additionally, the API documentation is available for more detailed information and troubleshooting tips.

monobank-open-api-documentation's People

Contributors

siomochkin avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.