{ "swagger": "2.0", "host": "127.0.0.1:3001", "basePath": "/", "schemes": [ "http" ], "info": { "title": "Central Ledger API Documentation", "version": "9.3.0" }, "tags": [], "paths": { "/enums": { "get": { "operationId": "getEnums", "tags": [ "enums" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/health": { "get": { "operationId": "getHealth", "tags": [ "health" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/metrics": { "get": { "summary": "Prometheus metrics endpoint", "operationId": "getMetrics", "tags": [ "metrics" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants": { "get": { "operationId": "getParticipants", "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } }, "post": { "operationId": "postParticipants", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%201" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/limits": { "get": { "summary": "View limits for all participants", "operationId": "getParticipantsLimits", "parameters": [ { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ], "name": "currency", "in": "query" }, { "type": "string", "description": "Limit Type", "name": "type", "in": "query", "required": false } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}": { "get": { "operationId": "getParticipantsName", "parameters": [ { "type": "string", "description": "Participant name", "name": "name", "in": "path", "required": true } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } }, "put": { "operationId": "putParticipantsName", "parameters": [ { "type": "string", "description": "Participant name", "name": "name", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%207" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}/endpoints": { "get": { "summary": "View participant endpoints", "operationId": "getParticipantsNameEndpoints", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } }, "post": { "summary": "Add/Update participant endpoints", "operationId": "postParticipantsNameEndpoints", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%202" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}/limits": { "get": { "summary": "View participant limits", "operationId": "getParticipantsNameLimits", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ], "name": "currency", "in": "query" }, { "type": "string", "description": "Limit Type", "name": "type", "in": "query", "required": false } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } }, "put": { "summary": "Adjust participant limits", "operationId": "putParticipantsNameLimits", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%209" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}/positions": { "get": { "summary": "View participant positions", "operationId": "getParticipantsNamePositions", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ], "name": "currency", "in": "query" } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}/accounts": { "get": { "summary": "View participant accounts and balances", "operationId": "getParticipantsNameAccounts", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } }, "post": { "summary": "Create hub accounts", "operationId": "postParticipantsNameAccounts", "parameters": [ { "type": "string", "description": "Participant name", "name": "name", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%204" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}/initialPositionAndLimits": { "post": { "summary": "Add initial participant limits and position", "operationId": "postParticipantsNameInitialpositionandlimits", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%203" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}/accounts/{id}": { "post": { "summary": "Record Funds In or Out of participant account", "operationId": "postParticipantsNameAccountsId", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "type": "integer", "x-constraint": { "positive": true }, "name": "id", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%206" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } }, "put": { "summary": "Update participant accounts", "operationId": "putParticipantsNameAccountsId", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "type": "integer", "x-constraint": { "positive": true }, "name": "id", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%2010" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/participants/{name}/accounts/{id}/transfers/{transferId}": { "put": { "summary": "Record Funds In or Out of participant account", "operationId": "putParticipantsNameAccountsIdTransfersTransferid", "parameters": [ { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true }, "name": "name", "in": "path", "required": true }, { "type": "integer", "x-constraint": { "positive": true }, "name": "id", "in": "path", "required": true }, { "type": "string", "x-format": { "guid": true }, "name": "transferId", "in": "path", "required": true }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Model%2011" } } ], "tags": [ "participants" ], "responses": { "default": { "schema": { "type": "string" }, "description": "Successful" } } } }, "/settlementModels" : { "get" : { "tags" : [ "settlementModels" ], "operationId" : "getSettlementmodels", "parameters" : [ ], "responses" : { "default" : { "description" : "Successful", "schema" : { "type" : "string" } } } }, "post" : { "tags" : [ "settlementModels" ], "operationId" : "postSettlementmodels", "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/Model%2012" } } ], "responses" : { "default" : { "description" : "Successful", "schema" : { "type" : "string" } } } } }, "/settlementModels/{name}" : { "get" : { "tags" : [ "settlementModels" ], "operationId" : "getSettlementmodelsName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "SettlementModel name", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "Successful", "schema" : { "type" : "string" } } } }, "put" : { "tags" : [ "settlementModels" ], "operationId" : "putSettlementmodelsName", "parameters" : [ { "name" : "name", "in" : "path", "description" : "settlementModel name", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/Model%2013" } } ], "responses" : { "default" : { "description" : "Successful", "schema" : { "type" : "string" } } } } } }, "definitions": { "Model 1": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the participant", "minLength": 2, "maxLength": 30, "x-format": { "alphanum": true } }, "currency": { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ] } }, "required": [ "name" ] }, "Model 2": { "type": "object", "properties": { "type": { "type": "string", "description": "Endpoint Type" }, "value": { "type": "string", "description": "Endpoint Value" } }, "required": [ "type", "value" ] }, "limit": { "type": "object", "description": "Participant Limit", "properties": { "type": { "type": "string", "description": "Limit Type" }, "value": { "type": "number", "description": "Limit Value", "enum": [ 0 ], "x-constraint": { "positive": true } } }, "required": [ "type", "value" ] }, "Model 3": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ] }, "limit": { "$ref": "#/definitions/limit" }, "initialPosition": { "type": "number", "description": "Initial Position Value" } }, "required": [ "limit" ] }, "Model 4": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ] }, "type": { "type": "string", "description": "Account type" } }, "required": [ "type" ] }, "No amount provided": { "type": "object", "properties": { "amount": { "type": "number", "x-constraint": { "precision": 4, "positive": true } }, "currency": { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ] } }, "required": [ "amount" ] }, "Model 5": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "extension": { "type": "array", "items": { "$ref": "#/definitions/Model%205" } }, "extensionList": { "type": "object", "properties": { "extension": { "$ref": "#/definitions/extension" } } }, "Model 6": { "type": "object", "properties": { "transferId": { "type": "string", "x-format": { "guid": true } }, "externalReference": { "type": "string" }, "action": { "type": "string", "enum": [ "recordFundsIn", "recordFundsOutPrepareReserve" ] }, "reason": { "type": "string" }, "amount": { "$ref": "#/definitions/No%20amount%20provided" }, "extensionList": { "$ref": "#/definitions/extensionList" } }, "required": [ "transferId", "externalReference", "action", "reason", "amount" ] }, "Model 7": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Participant isActive boolean" } }, "required": [ "isActive" ] }, "Model 8": { "type": "object", "description": "Participant Limit", "properties": { "type": { "type": "string", "description": "Limit Type" }, "value": { "type": "number", "description": "Limit Value" }, "alarmPercentage": { "type": "number", "description": "limit threshold alarm percentage value" } }, "required": [ "type", "value", "alarmPercentage" ] }, "Model 9": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency code", "enum": [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ] }, "limit": { "$ref": "#/definitions/Model%208" } }, "required": [ "limit" ] }, "Model 10": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Participant currency isActive boolean" } }, "required": [ "isActive" ] }, "Model 11": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "recordFundsOutCommit", "recordFundsOutAbort" ] }, "reason": { "type": "string" } }, "required": [ "reason" ] }, "Model 12" : { "type" : "object", "required" : [ "autoPositionReset", "ledgerAccountType", "name", "requireLiquidityCheck", "settlementDelay", "settlementGranularity", "settlementInterchange" ], "properties" : { "name" : { "type" : "string", "description" : "Name of the settlement model", "minLength" : 2, "maxLength" : 30, "x-format" : { "alphanum" : true } }, "settlementGranularity" : { "type" : "string", "description" : "Granularity type for the settlement model GROSS or NET", "enum" : [ "GROSS", "NET" ] }, "settlementInterchange" : { "type" : "string", "description" : "Interchange type for the settlement model BILATERAL or MULTILATERAL", "enum" : [ "BILATERAL", "MULTILATERAL" ] }, "settlementDelay" : { "type" : "string", "description" : "Delay type for the settlement model IMMEDIATE or DEFERRED", "enum" : [ "DEFERRED", "IMMEDIATE" ] }, "currency" : { "type" : "string", "description" : "Currency code", "enum" : [ "AED", "AFA", "AFN", "ALL", "AMD", "ANG", "AOA", "AOR", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EEK", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMK", "ZMW", "ZWD", "ZWL", "ZWN", "ZWR" ] }, "requireLiquidityCheck" : { "type" : "boolean", "description" : "Liquidity Check boolean" }, "ledgerAccountType" : { "type" : "string", "description" : "Account type for the settlement model POSITION, SETTLEMENT or INTERCHANGE_FEE", "enum" : [ "INTERCHANGE_FEE", "POSITION" ] }, "autoPositionReset" : { "type" : "boolean", "description" : "Automatic position reset setting, which determines whether to execute the settlement transfer or not" } } }, "Model 13" : { "type" : "object", "required" : [ "isActive" ], "properties" : { "isActive" : { "type" : "boolean", "description" : "settlementModel isActive boolean" } } } } }