Obtain issuers
Description
Use Case allows an External Entity or an Individual to request a list of available Issuers.
Actors
- External Entity that can interact with System Operator API acting as a registered System Operator user with permissions: ISSUER_VIEWER.
- System Operator running “SDK.Finance” software and exposing portfolio of financial APIs.
Preconditions
- The user must have a System Operator profile.
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.
- Perform all steps of Use Case “Authentication”.
- External Entity sends a request to get a list all Issuers.
Endpoint URL: https://sdkfinance.app/api/ui/#!/Issuers/Obtain_issuers
Parameters:
Authorization – authorization token
- System Operator returns a List of Issuers to External Entity.
Optional Flow with Web Browser UI
- Perform all steps of Use Case “Authentication”.
- The user sends a request to get a list of all Issuers.
Endpoint URL: https://sdkfinance.app/api/ui/#!/Issuers/Obtain_issuers
Parameters:
Authorization – authorization token
- System Operator returns a web page with a List of all Issuers to User.
Post Conditions
External Entity or User can see Issuers and corresponding Currencies.
Result example
{ "records":[ { "id":"add864c2-0d26-4bc2-a459-7fe51f501021", "sn":"USD", "name":"USD issuer", "description":"desc", "orderNumber":100, "orderQuote":100, "active":true, "currency":{ "code":"USD", "digitalCode":"840", "symbol":"$", "name":"US Dollar", "description":null } }, { "id":"ae8fa896-750a-4459-a7a6-e6a3ff2852ee", "sn":"EUR", "name":"EUR issuer", "description":"desc", "orderNumber":200, "orderQuote":200, "active":true, "currency":{ "code":"EUR", "digitalCode":"978", "symbol":"€", "name":"Euro", "description":null } }, { "id":"2b51bbc0-e112-4723-86c6-7bcb966d6846", "sn":"UAH", "name":"UAH issuer", "description":"desc", "orderNumber":300, "orderQuote":100, "active":true, "currency":{ "code":"UAH", "digitalCode":"980", "symbol":"₴", "name":"Ukrainian Hryvnia", "description":null } } ] } |