Currencies
This section deals with currencies and foreign exchanges rates, either available for your use or that you need to add to your solution account
Returns all registered currencies
POST
https://api.bws.ninja/v1/call
Use this operation to list currencies you have registered for your account.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getCurrencies |
Example responses
Example code
Returns all registered foreign exchange rates
POST
https://api.bws.ninja/v1
Use this operation to list foreign exchange rates you have registered for a particular reporting year.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getFXrates |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type | Required | Description |
---|---|---|---|
reporting_year | number/4 digits | yes | Calendar year that the FX rate is used for |
Example code
Adds a currency to your solution account
POST
https://api.bws.ninja/v1/call
Use this operation to add currencies that you foresee being applicable to your green asset universe, and for which you want to add foreign exchange rates.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addCurrency |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Desciption |
---|---|---|---|
currency_code | string/3 char. | yes | Standard currency code |
Example code
Adds a foreign exchange rate between two currencies
POST
https://api.bws.ninja/v1/call
Use this operation to add foreign exchnage rate for currencies applicable to your green asset universe.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addFXrate |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
currency_code_numerator | string/3 char. | yes | Standard currency code |
currency_code_denominator | string/3 char. | yes | Standard currency code |
currency_code_quota | number/decimal | yes | numerator / denominator |
reporting_year | number/4 digits | yes | Calendar year that the FX rate will be used for |
Example code
Removes a currency
POST
https://api.bws.ninja/v1/call
Use this operation to remove a currency from your records
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removeCurrency |
parameters* | string | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
currency_code | string | yes |
Example code
Removes an FX rate
POST
https://api.bws.ninja/v1/call
Use this operation to remove an FX rate between two currencies
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removeFXrate |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
currency_code_1 | string | yes | |
currency_code_2 | string | yes | |
reporting_year | number/4 digits | yes |
Example code
Last updated