Skip to content

Commit

Permalink
Merge pull request #34 from HenkKodde/master
Browse files Browse the repository at this point in the history
Release 8.6.0 and building gh-pages.
  • Loading branch information
HenkKodde authored Nov 29, 2019
2 parents a82f135 + 42a4bc7 commit a6d877f
Show file tree
Hide file tree
Showing 138 changed files with 16 additions and 22,699 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[![Git Commit](https://img.shields.io/github/last-commit/mojaloop/mojaloop-specifications.svg?style=flat)](https://github.com/mojaloop/mojaloop-specifications/commits/master)
[![Git Releases](https://img.shields.io/github/release/mojaloop/mojaloop-specifications.svg?style=flat)](https://github.com/mojaloop/mojaloop-specifications/releases)
[![CircleCI](https://circleci.com/gh/mojaloop/mojaloop-specifications.svg?style=svg)](https://circleci.com/gh/mojaloop/mojaloop-specifications)
# Open API for FSP Interoperability Specification
The Open API for FSP Interoperability Specification includes the following documents.

Expand Down Expand Up @@ -28,10 +31,10 @@ Information is shared in accordance with **Creative Commons Licensing**.
This document introduces the four generic transaction patterns that are supported in a logical version of the API. Additionally, all logical services that are part of the API are presented on a high-level.

## Generic Transaction Patterns
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/Generic%20Transaction%20Patterns.pdf) specifies the logical data model used by the API. Section 2 in the document lists elements used by each service. Section 3 in the document describes the data model in terms of basic elements, simple data types and complex data types.
[This document](https://github.com/mojaloop/mojaloop-specification/documents/supporting-documentation/blob/master/Generic%20Transaction%20Patterns.pdf) specifies the logical data model used by the API. Section 2 in the document lists elements used by each service. Section 3 in the document describes the data model in terms of basic elements, simple data types and complex data types.

## Use Cases
The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/blob/master/Use%20Cases.pdf) is to define a set of use cases that can be implemented using the API. The use cases referenced within this document provide an overview of transaction processing flows and business rules of each transaction step as well as relevant error conditions. The primary purpose of the API is to support the movement of financial transactions between one Financial Services Provider (FSP) and another.
The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/documents/supporting-documentation/blob/master/Use%20Cases.pdf) is to define a set of use cases that can be implemented using the API. The use cases referenced within this document provide an overview of transaction processing flows and business rules of each transaction step as well as relevant error conditions. The primary purpose of the API is to support the movement of financial transactions between one Financial Services Provider (FSP) and another.

It should be noted that the API is only responsible for message exchange between FSPs and a Switch when a cross-FSP transaction is initiated by an End User in one of the FSPs. This can occur in either of two scenarios:
- A bilateral scenario in which FSPs communicate with each other
Expand All @@ -40,7 +43,7 @@ It should be noted that the API is only responsible for message exchange between
Reconciliation, clearing and settlement after real time transactions is out of scope for the API. Additionally, account lookup is supported by the API, but it relies on the implementation in a local market in which a third party or Switch would provide such services. Therefore, the need for effective on-boarding processes and appropriate scheme rules must be considered when implementing use cases.

## API Definition
The [**API Definition** document](https://github.com/mojaloop/mojaloop-specification/blob/master/API%20Definition%20v1.0.md) introduces and describes **the API**. The purpose of the API is to enable interoperable financial transactions between a Payer (a payer of electronic funds in a payment transaction) located in one FSP (an entity that provides a digital financial service to an end user) and a Payee (a recipient of electronic funds in a payment transaction) located in another FSP. The API does not specify any front-end services between a Payer or Payee and its own FSP; all services defined in the API are between FSPs. FSPs are connected either (a) directly to each other or (b) by a Switch placed between the FSPs to route financial transactions to the correct FSP.
The [**API Definition** document](https://github.com/mojaloop/mojaloop-specification/documents/supporting-documentation/blob/master/API%20Definition%20v1.0.md) introduces and describes **the API**. The purpose of the API is to enable interoperable financial transactions between a Payer (a payer of electronic funds in a payment transaction) located in one FSP (an entity that provides a digital financial service to an end user) and a Payee (a recipient of electronic funds in a payment transaction) located in another FSP. The API does not specify any front-end services between a Payer or Payee and its own FSP; all services defined in the API are between FSPs. FSPs are connected either (a) directly to each other or (b) by a Switch placed between the FSPs to route financial transactions to the correct FSP.
The transfer of funds from a Payer to a Payee should be performed in near real-time. As soon as a financial transaction has been agreed to by both parties, it is deemed irrevocable. This means that a completed transaction cannot be reversed in the API. To reverse a transaction, a new negated refund transaction should be created from the Payee of the original transaction.

The API is designed to be sufficiently generic to support both a wide number of use cases and extensibility of those use cases, However, it should contain sufficient detail to enable implementation in an unambiguous fashion.
Expand All @@ -51,7 +54,7 @@ This document:
- Adds to and builds on the information provided in Open API for FSP Interoperability Specification. The contents of the Specification are listed in Section **Open API for FSP Interoperability Specification**.

## Scheme Rules
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/Scheme%20Rules.pdf) defines scheme rules for Open API for FSP Interoperability (hereafter cited as the API) in three categories.
[This document](https://github.com/mojaloop/mojaloop-specification/documents/supporting-documentation/blob/master/Scheme%20Rules.pdf) defines scheme rules for Open API for FSP Interoperability (hereafter cited as the API) in three categories.
1. Business Scheme Rules:
a. These business rules should be governed by FSPs and an optional regulatory authority implementing the API within a scheme.
b. The regulatory authority or implementing authority should identify valid values for these business scheme rules in their API policy document.
Expand All @@ -62,7 +65,7 @@ b. All participants should configure these API parameters as indicated by the AP
a. Security and non-functional scheme rules should be determined and identified in the implementation policy of a scheme.

## JSON Binding Rules
The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/blob/master/JSON%20Binding%20Rules.pdf) is to express the data model used by **the API** in the form of JSON Schema binding rules, along with validation rules for the corresponding instances.
The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/documents/supporting-documentation/blob/master/JSON%20Binding%20Rules.pdf) is to express the data model used by **the API** in the form of JSON Schema binding rules, along with validation rules for the corresponding instances.

This document adds to and builds on the information provided in Open API for FSP Interoperability Specification. The contents of the Specification are listed in Section 1.1.
The types used in the PDP API fall primarily into three categories:
Expand All @@ -84,7 +87,7 @@ b. All participants should configure these API parameters as indicated by the AP
a. Security and non-functional scheme rules should be determined and identified in the implementation policy of a scheme.

## PKI Best Practices
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/PKI%20Best%20Practices.pdf) explains Public Key Infrastructure (PKI) best practices to apply in **the API** deployment. See Chapter 2, PKI Background, for more information about PKI.
[This document](https://github.com/mojaloop/mojaloop-specification/documents/supporting-documentation/blob/master/PKI%20Best%20Practices.pdf) explains Public Key Infrastructure (PKI) best practices to apply in **the API** deployment. See Chapter 2, PKI Background, for more information about PKI.
The API should be implemented in an environment that consists of either:
- Financial Service Providers (FSPs) that communicate with other FSPs (in a bilateral setup) or
- A Switch that acts as an intermediary platform between FSP platforms. There is also an Account Lookup System (ALS) available to identify in which FSP an account holder is located.
Expand Down
7 changes: 5 additions & 2 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Table of contents

### Documents
* [Mojaloop Specifications Overview](README.md)
* [API Definition v1.0](API Definition v1.0.md)
* [Issue-and-Decision-Log](ccb-meetings/Issue-and-Decision-Log.md)
* [API Definition v1.0](documents/API Definition v1.0.md)
### Change Control Board
* [Change Control Board Overview](ccb-meetings/README.md)
* [Issue-and-Decision-Log](ccb-meetings/Issue-and-Decision-Log.md)
<!--* [Changelog](changelog.md)-->
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file removed html-format/API-Definition-1.fld/image001.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image002.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image003.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image004.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image005.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image006.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image007.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image008.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image009.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image010.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image011.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image012.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image013.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image014.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image015.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image016.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image017.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image018.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image019.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image020.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image021.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image022.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image023.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image024.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image025.png
Binary file not shown.
Binary file removed html-format/API-Definition-1.fld/image026.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image027.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image028.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image029.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image030.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image031.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image032.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image033.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image034.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image035.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image036.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image037.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image038.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image039.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image040.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image041.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image042.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image043.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image044.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image045.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image046.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image047.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image048.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image049.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image050.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image051.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image052.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image053.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image054.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image055.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image056.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image057.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image058.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image059.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image060.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image061.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image062.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image063.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image064.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image065.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image066.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image067.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image068.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image069.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image070.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image071.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image072.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image073.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image074.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image075.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image076.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image077.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image078.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image079.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image080.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image081.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image082.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image083.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image084.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image085.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image086.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image087.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image088.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image089.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image090.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image091.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image092.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image093.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image094.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image095.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image096.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image097.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image098.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image099.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image100.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image101.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image102.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image103.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image104.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image105.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image106.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image107.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image108.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image109.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image110.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image111.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image112.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image113.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image114.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image115.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image116.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image117.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image118.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image119.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image120.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image121.png
Diff not rendered.
Binary file removed html-format/API-Definition-1.fld/image122.png
Diff not rendered.
Loading

0 comments on commit a6d877f

Please sign in to comment.