CorebanqCorebanq Developer Docs
Currenciesv1

Update currency

Handler: UpdateCurrencyByID. Requires RBAC PermUpdate. Full replace via models.UpdateCurrencyInput fields present in JSON (commonutil.Populate). Returns updated models.Currency.

PUT
/v1/currencies/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

models.UpdateCurrencyInput. All fields optional at JSON level; omitted fields may zero out on populate depending on commonutil.Populate semantics.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/currencies/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "string",
  "numeric_code": "string",
  "name": "string",
  "description": "string",
  "symbol": "string",
  "decimal_places": 0,
  "precision": 0,
  "rounding": "up",
  "is_fiat": true,
  "is_base": true,
  "format": "string",
  "display_priority": 0,
  "icon_url": "string",
  "active": true,
  "metadata": {},
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "modified_at": "2019-08-24T14:15:22Z",
  "modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f"
}
{
  "status": 400,
  "message": "Invalid input"
}
{
  "status": 401,
  "message": "Unauthorized"
}
{
  "status": 403,
  "message": "Forbidden"
}
{
  "status": 404,
  "message": "Not found"
}
{
  "status": 500,
  "message": "server_error"
}