Updating a Currency
Endpoint: PUT /admin/currencies/{currency_id}
Purpose
This endpoint is used to update an existing currency’s details in the system. It allows modifications to attributes such as the currency name, ISO code, associated country, symbol, rounding method, precision, and activation status. Upon successful update, the response returns the modified currency details, including a timestamp of the last update.
Path Parameters
No path parameters for this endpoint.
Query Parameters
This endpoint does not have any query parameters.
Use Case
This endpoint is useful when an organization needs to modify currency settings due to changes in financial regulations, business operations, or system updates. It ensures that currency information remains accurate and reflects the latest configurations for transactions, pricing, and reporting.
Request Body
| Parameter | Type | Description |
|---|---|---|
| name | string | The updated full name of the currency. |
| code | string | The three-letter ISO currency code. |
| country | string | The updated name of the country associated with the currency. |
| countryCode | string | The two-letter country code. |
| symbol | string | The updated symbol representing the currency. |
| active | boolean | Determines if the currency remains active (true) or inactive (false). |
| rounding | string | Specifies the rounding rule. |
| precision | integer | Number of decimal places for transactions. |
{
"NAME": "CURRENCY_NAME",
"CODE": "CURRENCY_CODE",
"COUNTRY": "COUNTRY_NAME",
"COUNTRYCODE": "COUNTRY_CODE",
"SYMBOL": "CURRENCY_SYMBOL",
"ACTIVE": "IS_ACTIVE",
"ROUNDING": "ROUNDING_TYPE",
"PRECISION": "DECIMAL_PRECISION"
}Response
The response contains a currency object that includes the updated currency details, such as its ID, name, code, symbol, country, and last update timestamp.
{
"CURRENCY": {
"ID": "CURRENCY_ID",
"NAME": "CURRENCY_NAME",
"CODE": "CURRENCY_CODE",
"COUNTRY": {
"ID": "COUNTRY_ID",
"NAME": "COUNTRY_NAME",
"CODE": "COUNTRY_CODE"
},
"SYMBOL": "CURRENCY_SYMBOL",
"ACTIVE": "IS_ACTIVE",
"ROUNDING": "ROUNDING_TYPE",
"PRECISION": "DECIMAL_PRECISION",
"UPDATED_AT": "LAST_UPDATED_TIMESTAMP"
}
}