Obtain all currencies

Updated on 12 Jun 2020

Description

After executing all steps of “Authentication” Use Case a User with privileges CURRENCY_VIEWER,

CURRENCY_MANAGER requests a List of currencies in the system.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator user with privileges CURRENCY_VIEWER, CURRENCY_MANAGER.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Preconditions

  1. The user must have a System Operator profile.
  2. The user must have enough access privileges to see currencies.

Basic Flow

By default, this flow assumes that External Entity sends Requests to System Operator Endpoints and System Operator sends back Responses to External Entity.

  1. Perform all steps of Use Case “Authentication”.
  2. External Entity sends a request to Endpoint “Obtain all currencies”.

Endpoint URL: https://sdkfinance.app/api/ui/#!/Currency/Obtain_all_currencies

Parameters:

Authorization – authorization token

  1. System Operator returns a List of available currencies. (See Result example below)

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “Authentication”.
  2. A user sends a request to Endpoint “Obtain all currencies”.

Endpoint URL: https://sdkfinance.app/api/ui/#!/Currency/Obtain_all_currencies

Parameters:

Authorization – authorization token

  1. System Operator returns a List of available currencies. (See Result example below)

Post Conditions

List of currencies is available.

Result example



   "currencies":[ 

      { 

         "code":"USD",

         "digitalCode":"840",

         "symbol":"$",

         "name":"US Dollar",

         "description":null

      },

      { 

         "code":"EUR",

         "digitalCode":"978",

         "symbol":"€",

         "name":"Euro",

         "description":null

      },

      { 

         "code":"UAH",

         "digitalCode":"980",

         "symbol":"₴",

         "name":"Ukrainian Hryvnia",

         "description":null

      }

   ],

   "status":"ok",

   "message":"processed successfully"

}