File an exchange rate

Admin only. Files a rate for one ordered pair. Rates are append only, so a correction is another POST and a frozen sale keeps its rate.

POST/api/v1/currency/rates

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Request body

requiredapplication/json

base_codestringrequired

quote_codestringrequired

ratenumberrequired

effective_atstring

sourcestring

Responses

201

Rate filed

idstringrequired

base_codestringrequired

quote_codestringrequired

ratenumberrequired

sourcestringrequired

effective_atstringrequired

created_atstringrequired

400

base_code or quote_code is missing, the pair is a currency against itself, a currency is unknown or inactive, or the rate is not positive

detailstringrequired

403

Caller is not an admin

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

base_codestring*quote_codestring*ratenumber*effective_atstringsourcestring

Request

curl -X POST 'http://localhost:8000/api/v1/currency/rates' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "base_code": "string",
  "quote_code": "string",
  "rate": 1,
  "effective_at": "string",
  "source": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/currency/rates", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"base_code\": \"string\",\n  \"quote_code\": \"string\",\n  \"rate\": 1,\n  \"effective_at\": \"string\",\n  \"source\": \"string\"\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/currency/rates",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"base_code\": \"string\",\n  \"quote_code\": \"string\",\n  \"rate\": 1,\n  \"effective_at\": \"string\",\n  \"source\": \"string\"\n}",
)

Response

{
  "id": "string",
  "base_code": "string",
  "quote_code": "string",
  "rate": 0,
  "source": "string",
  "effective_at": "string",
  "created_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}