Skip to content

Exchange rate

Returns the partner bank's commercial rate to UZS including the spread (sell_rate/buy_rate). Use this to display the rate in the UI. For an exact conversion amount calculation, use «Conversion (sell)» or «Conversion (buy)».

URL

GET https://api.pay.kvell.group/v1/currency/rates

GET https://api.pay.stage.kvell.group/v1/currency/rates

Request

Query parameters

Parameter Type Required Description
ccy string Yes Numeric ISO 4217 currency code, e.g. "840" (USD). See «Currency codes».

Headers

Name Type Required Description
X-Api-Key string Yes Shop identifier.

The X-Signature signature is not required for this method.

Example

curl --request GET \
  --url 'https://api.pay.stage.kvell.group/v1/currency/rates?ccy=840' \
  --header 'X-Api-Key: 00000000-0000-4000-8000-000000000000'

Response

Example 200 (OK) response
{
  "currency": "840",
  "sell_rate": 12210,
  "buy_rate": 12155
}

Response parameters

Parameter Type Description
currency string Numeric code of the requested currency.
sell_rate number Bank's selling price for the currency, in UZS per 1 unit of currency.
buy_rate number Bank's buying price for the currency, in UZS per 1 unit of currency.

What this response means

The rate is current as of the response and may change on the next request.

What to do next

Use sell_rate/buy_rate to display the rate. For an exact transfer amount calculation, use «Conversion (sell)» or «Conversion (buy)».

Example 404 (Not Found) response
{
  "errors": [
    {
      "code": 20044,
      "message": "The integration with Montra is not configured for the shop"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and handling recommendations are given in «HTTP response errors».
errors[].code integer 20044 — integration not connected; 20099 — the rate for this currency is unavailable from the provider.
errors[].message string Description of the reason.

What this response means

For code 20044, contact KVELL support to connect the integration with the rates provider. For code 20099, check the currency code in ccy.

What to do next

Fix the cause of the error and retry the request.

Example 422 (Unprocessable Entity) response
{
  "errors": [
    {
      "code": 20098,
      "message": "ccy: Field required"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of validation errors.
errors[].code integer Error code.
errors[].message string Field and reason for the validation error.

What this response means

The required ccy parameter was not passed, or it does not match the expected format.

What to do next

Fix the field from errors[].message and retry the request.

Example 5XX (Internal Server Error) response
{
  "errors": [
    {
      "code": 20000,
      "message": "Unknown error"
    }
  ]
}

Response parameters

Parameter Type Description
errors array List of errors. Codes and handling recommendations are given in «HTTP response errors».
errors[].code integer Error code.
errors[].message string Description of the technical error.

What this response means

The method is read-only and changes nothing — a technical error cannot lead to an indeterminate result.

What to do next

Safely retry the same request. If the error persists, contact KVELL support and provide the URL, request time, HTTP code, code, and message.