UAPI Flow

This guide provides detailed diagrams of Neonomics API flows.

The diagrams below illustrate the following:

  • the flow of API requests and responses between the Client application and the Neonomics platform
  • the flow of interactions between the Neonomics platform and the banks
  • requests and responses involving end-users (marked in grey)
  • vital processes internally in the Neonomics platform

The purpose of the diagrams is to give an overall view to aid you in implementing Neonomics APIs.

When you need more details about each API, please see the relevant page in the API References for a full definition. You can also find stepwise descriptions of the accounts and payments processes, including request and response examples.

πŸ“˜

Info

You need a valid access_token to make requests to the Neonomics API. Please refer to the authentication guide to obtain it.

This token is used in all requests to our APIs.

Accounts

The most common scenario for account information requests is that the end-user has not yet given consent to it.

Main account scenario

Consent not given

Alternative account scenario

Consent given

In this scenario, a valid consent to account information requests already exists.

Payments

The payments diagrams assume that a sessionId already is created.

Note that the Initiate Payment request in the diagrams below represents the initiation of any of these payment types:

The most common payment initiation scenario, illustrated below, is a situation where the end-user has given consent to payment initiation on the debtor account, and the payment is not exempt from authorization.

Main payment scenario

Valid consent already exists for the account; the payment is not exempt from authorization.

Other payment scenarios

The alternative scenarios are illustrated below.

Valid consent already exists for the account; the payment is exempt from authorization.

Consent is required for the account; the payment is exempt from authorization.

Consent is required for the account; payment authorization is required.