Minka Ledger Docs

Introduction

We’d appreciate your feedback on the developer ergonomics and capabilities as part of our Early Access Program (EAP).

Summary

Our developer documentation is organized in 4 main areas:

  1. Tutorials
  2. Guides
  3. References
  4. Explanations

Minka Ledger enables organizations to securely publish and transfer money and balances on the Web.

It is a unified transaction model for expressing money and balances so that companies can talk to each other using a common language with a small set of primitives.

Money and balances published through Minka ledgers can be moved securely to any other connected ledger in real time using digital signatures.

Key benefits include:

  • Payment simplification
    • Express otherwise complex payment flows by combining a few basic ledger primitives
    • Accelerate the creation of new payment services by modelling everything as ledger entries
    • Enable business models like micropayments by streaming transactions to your ledger
  • Easy integration
    • A simple API with a small number of endpoints that are easy to understand and integrate
    • The right abstractions for money. Use the same low-level API calls for multiple high-level payment flows
    • Integrate once, implement anything. Build multiple financial products on the same ledger integration
  • Full interoperability
    • Move balances between formerly separate systems
    • Transact with remote ledgers by forwarding requests that look like calls to your local ledger
    • Expose business functionality for other companies to consume using a clean and uniform interface
  • Secure by design
    • Leverage the security properties of various cryptographic primitives from the Bitcoin protocol
    • Ensure the integrity of transaction requests and records using cryptographic hashes
    • Verify the authenticity of payment requests using public-key cryptography and digital signatures
  • Automated operation
    • Cloud solution, hosted and managed by Minka
    • Regular security updates delivered automatically
    • New features released on regular basis

Tutorials

Lessons that guide you through a series of steps to complete a project.

Getting started with ledger

Build a Ledger that tracks business account balances and exposes APIs that allow businesses to onboard and make payments easily.

Making cross-ledger payments

Connect your banking core or middleware to the ledger service in the cloud.

Real time payments


Tutorials on how to integrate with a real time payments rail built using ledger.

Joining an RTP system

Create your account and join an existing real time payments system.

Creating your first payment

Setup Minka CLI and create your first real time payment using a test bank.

Integrating with an RTP rail

Integrating banking core systems with a real time payments rail.

Building a bridge service

Build a bridge service to connect a banking core or middleware with a real time payments rail.


Alias directory


Tutorials on how to configure and use an alias directory with ledger.

Building an alias directory

Use ledger to manage aliases and external payment information.

Connecting to an alias directory

Develop an integration to access alias directory from existing systems.

Alias directory onboarding tutorial

Create alias directory records and use them to route payments.

Advanced bank integrations


Tutorials on how to build a bank integration in NodeJs.

Bank integration tutorial (open banking)

This tutorial will show you how to connect banking services to the minka network.

Bank integration tutorial (open banking) with Bridge SDK

This tutorial will show you how to connect banking services to the minka network using the Bridge SDK.

How-to guides

Directions that explain the steps required to solve a real-world problem.

How to generate signing keys in code

How to hash and sign Ledger requests

How to set custom data to Ledger records

How to register an effect

How to handle effect webhook calls

How to set up ledger access rules

How to set up record access rules

How to authenticate with JWT

How to assign a signer to a circle

How to set up access rules based on circles

How to drop a signer from a circle

How to set up access rules based on policies

How to query wallet anchors

How to drop an anchor

How to manage anchor labels

How to drop a wallet

How to apply limits to a wallet

How to read a layout

How to apply a layout

How to display differences between a layout and a ledger

How to sync a layout to a ledger

References

Technical descriptions of the main concepts and how to use them.

API reference

CLI reference

Error reference

SDK Cheat Sheet

Explanations

Provide clarity on a certain topic, help to better understand important concepts.

About Minka

About Ledgers

About Ledger Key Concepts

About Extending Ledger

About Security

About Wallets

About Bridges

About Intents

About Intents Expiry

About Authentication

About Authorization

About Alias Directory

About Referenced Records

About Schemas

About Circles

About Security Policies

About Labels Policies

About Status Policies

About Anchors

About Advices

About Queries

About Labels

About Statuses

About Layouts

About Domains

On this page