API Docs. Elcoin Ltd

Currency Rate. Fetch data by request POST

Get Currency Rate data by request

# ENDPOINT

/api/currencyRate/getData/currencyRateRequest

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0	DEV-SKIP	DEV-SKIP	M	Dev Authentication

# REQUEST BODY

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M	Dev Authentication
Example	DEV-SKIP

# REQUEST BODY

Schema: currencyRateRequest

Type: object

Variable	Name	Type	Format	Description
action	Action	string
balance_date	Balance Date	string	DATE	Date operation
base_currency	base_currency	string		Operation currency From
create_date	Create Date	string	DATETIME	The date entry was created on
create_user	Create User	string		The username of ABS user who has created an entry
currency	currency	string		Currency of the account
currency_one	Currency one	STRING
currency_two	Currency two	STRING
description	description	string		Description of a given record
document_reference	document_reference	string		The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
external_data	External data	string		Original response data received from external service provider
external_reference	External reference	string
form_title	form_title	string		Service field
from_balance_date	from_balance_date	string	DATE	Date operation From
id	id	integer	INT64	Record's sequence number generated in the system.
modify_date	Modify Date	string	DATETIME	The date entry was last modified on
modify_user	Modify User	string		The username of ABS user who has made last changes to the entry
rate	rate	number	decimal	Rate of operation
rate_exponenta	Rate exponenta	integer
rate_num	Rate num	double
rate_timestamp	rate_timestamp	string	DATETIME	Operation Date/time
rate_type	rate_type	string		Who set the exchange rate List of allowed values in field (value=>name): 0 BANK 1 BANK_CROSS 2 BUY 3 DEAL 4 MARKET 5 SELL
service_provider	Service provider	string		External service provider that ensures client remote registration List of allowed values in field (value=>name): 0 BINANCE 1 BLOOMBERG 2 BNM 3 BOE 4 CBR 5 ECB 6 LMAX 7 RAILSBANK 8 TRUEFX 9 ZEROHASH
state	state	integer	INT64	Record state for replication
to_balance_date	to_balance_date	string	DATE	Date operation To
uid	uid	string		Unique record identifier which is used to distinguish between existing records
unit	Unit	number
version	version	integer	INT64	Record version for replication
without_expiry	Without expiry	BOOLEAN		List of allowed values in field (value=>name): 0 false 1 true

# REQUEST BODY EXAMPLE

							{
    "currency":"USD",
    "from_balance_date":"2020/12/25",
    "to_balance_date":"2020/12/31"
}

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: currencyRate

Type: application/json

Variable	Name	Type	Description
status	status	string	Request execution status
error_description	Error Description	string	Description of error
error	Error Code	string	Error code
data_type	data_type	string	Type of data
total_records	total_records	string	Total count of records
data	data	array	data of Response

attribute: data

Variable	Name	Type	Format	Description
action	Action	string
balance_date	Balance Date	string	DATE	Date operation
base_currency	base_currency	string		Operation currency From
create_date	Create Date	string	DATETIME	The date entry was created on
create_user	Create User	string		The username of ABS user who has created an entry
currency	currency	string		Currency of the account
description	description	string		Description of a given record
document_reference	document_reference	string		The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
external_data	External data	string		Original response data received from external service provider
external_reference	External reference	string
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
modify_date	Modify Date	string	DATETIME	The date entry was last modified on
modify_user	Modify User	string		The username of ABS user who has made last changes to the entry
rate	rate	number	decimal	Rate of operation
rate_exponenta	Rate exponenta	integer
rate_num	Rate num	double
rate_timestamp	rate_timestamp	string	DATETIME	Operation Date/time
rate_type	rate_type	string		Who set the exchange rate
service_provider	Service provider	string		External service provider that ensures client remote registration
state	state	integer	INT64	Record state for replication
uid	uid	string		Unique record identifier which is used to distinguish between existing records
unit	Unit	number
version	version	integer	INT64	Record version for replication
without_expiry	Without expiry	BOOLEAN

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 4,
    "data": [
        {
            "id": 50539957,
            "uid": "fd8d3c03-af7d-46a5-7714-03629050f917",
            "version": 533467531,
            "state": 0,
            "modify_date": "2020-12-28T17:11:59.088",
            "modify_user": "root",
            "create_date": "2020-12-28T17:11:59.082",
            "create_user": "root",
            "currency": "USD",
            "balance_date": "2020-12-28",
            "rate_type": "ECB",
            "rate": 1.22190000,
            "unit": 1.00000000,
            "base_currency": "EUR",
            "description": ""
        },
        {
            "id": 50539989,
            "uid": "fa302e4a-cbc1-9dbf-7714-f3739089e0ea",
            "version": 535238123,
            "state": 0,
            "modify_date": "2020-12-29T20:35:49.220",
            "modify_user": "root",
            "create_date": "2020-12-29T20:35:49.213",
            "create_user": "root",
            "currency": "USD",
            "balance_date": "2020-12-29",
            "rate_type": "ECB",
            "rate": 1.22590000,
            "unit": 1.00000000,
            "base_currency": "EUR",
            "description": ""
        },
        {
            "id": 50540021,
            "uid": "ce5186e5-81f0-a6a9-7714-8981f0f1eb8c",
            "version": 538102153,
            "state": 0,
            "modify_date": "2020-12-30T17:20:31.032",
            "modify_user": "root",
            "create_date": "2020-12-30T17:20:31.007",
            "create_user": "root",
            "currency": "USD",
            "balance_date": "2020-12-30",
            "rate_type": "ECB",
            "rate": 1.22810000,
            "unit": 1.00000000,
            "base_currency": "EUR",
            "description": ""
        },
        {
            "id": 50540053,
            "uid": "97882ce2-2d4b-af82-7714-3191c892b713",
            "version": 541375128,
            "state": 0,
            "modify_date": "2020-12-31T17:14:51.892",
            "modify_user": "root",
            "create_date": "2020-12-31T17:14:51.890",
            "create_user": "root",
            "currency": "USD",
            "balance_date": "2020-12-31",
            "rate_type": "ECB",
            "rate": 1.22710000,
            "unit": 1.00000000,
            "base_currency": "EUR",
            "description": ""
        }
    ]
}

# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError

Type: application/json

Variable	Name	Type	Description
status	status	string	Request execution status
error_description	Error Description	string	Description of error
error	Error Code	string	Error code
data_type	data_type	string	Type of data
total_records	total_records	string	Total count of records
data	data	object	Empty object

# Other endpoints

Name	Endpoint
Currency Rate. Fetch data by ID	/model/currencyRate/getDb/{id}
Currency Rate. Create/update data	/model/currencyRate/putDb
Currency Rate. Delete item by ID	/api/currencyRate/deleteItem/{id}
Currency. Fetch data by ID / UID	/model/currency/getDb/{id}
Currency. Create/update data	/model/currency/putDb
Currency. Delete item by ID	/api/currency/deleteItem/{id}
Currency Pairs. Fetch data by request	/api/currencyPairs/getData/currencyPairsSearchRequest
Currency Pairs. Fetch data by ID / UID	/model/currencyPairs/getDb/{id}
Currency Pairs. Create/update data	/model/currencyPairs/putDb
Currency Pairs. Delete item by ID	/api/currencyPairs/deleteItem/{id}