Skip to main content
POST
Create exchange rate (NOT IMPLEMENTED)

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Body

application/json
rate
number
required

Exchange rate (units of to_currency per 1 unit of from_currency)

from_currency

ISO-4217 currency code OR UUID of the source currency. Alias: resolved to from_currency_id.

Pattern: ^[A-Z]{3}$
Example:

"USD"

from_currency_id
string<uuid>

UUID of the source currency (canonical form). Overrides from_currency if both provided.

to_currency

ISO-4217 currency code OR UUID of the target currency. Alias: resolved to to_currency_id.

Pattern: ^[A-Z]{3}$
Example:

"GBP"

to_currency_id
string<uuid>

UUID of the target currency (canonical form). Overrides to_currency if both provided.

as_of_date
string<date>

Date this rate applies to. Alias: effective_date.

effective_date
string<date>

Alias for as_of_date. Accepted if as_of_date is not provided.

source
string

Rate source identifier (e.g. ecb

external_source
string
external_id
string
metadata
object

Response

Created exchange rate

The response is of type object.