Create a currency

curl --request POST \
  --url https://api.arcuserp.com/v1/currencies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "EUR",
  "name": "Euro",
  "symbol": "EUR",
  "decimals": 2,
  "is_active": true,
  "metadata": {}
}
'

import requests

url = "https://api.arcuserp.com/v1/currencies"

payload = {
    "code": "EUR",
    "name": "Euro",
    "symbol": "EUR",
    "decimals": 2,
    "is_active": True,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: 'EUR',
    name: 'Euro',
    symbol: 'EUR',
    decimals: 2,
    is_active: true,
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/currencies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/currencies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'EUR',
    'name' => 'Euro',
    'symbol' => 'EUR',
    'decimals' => 2,
    'is_active' => true,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/currencies"

	payload := strings.NewReader("{\n  \"code\": \"EUR\",\n  \"name\": \"Euro\",\n  \"symbol\": \"EUR\",\n  \"decimals\": 2,\n  \"is_active\": true,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/currencies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"EUR\",\n  \"name\": \"Euro\",\n  \"symbol\": \"EUR\",\n  \"decimals\": 2,\n  \"is_active\": true,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/currencies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"EUR\",\n  \"name\": \"Euro\",\n  \"symbol\": \"EUR\",\n  \"decimals\": 2,\n  \"is_active\": true,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "currency",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "USD",
  "name": "<string>",
  "symbol": "<string>",
  "decimals": 2,
  "is_active": true,
  "is_base": false,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

POST

currencies

Create a currency

curl --request POST \
  --url https://api.arcuserp.com/v1/currencies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "EUR",
  "name": "Euro",
  "symbol": "EUR",
  "decimals": 2,
  "is_active": true,
  "metadata": {}
}
'

import requests

url = "https://api.arcuserp.com/v1/currencies"

payload = {
    "code": "EUR",
    "name": "Euro",
    "symbol": "EUR",
    "decimals": 2,
    "is_active": True,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: 'EUR',
    name: 'Euro',
    symbol: 'EUR',
    decimals: 2,
    is_active: true,
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/currencies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/currencies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'EUR',
    'name' => 'Euro',
    'symbol' => 'EUR',
    'decimals' => 2,
    'is_active' => true,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/currencies"

	payload := strings.NewReader("{\n  \"code\": \"EUR\",\n  \"name\": \"Euro\",\n  \"symbol\": \"EUR\",\n  \"decimals\": 2,\n  \"is_active\": true,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/currencies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"EUR\",\n  \"name\": \"Euro\",\n  \"symbol\": \"EUR\",\n  \"decimals\": 2,\n  \"is_active\": true,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/currencies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"EUR\",\n  \"name\": \"Euro\",\n  \"symbol\": \"EUR\",\n  \"decimals\": 2,\n  \"is_active\": true,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "currency",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "USD",
  "name": "<string>",
  "symbol": "<string>",
  "decimals": 2,
  "is_active": true,
  "is_base": false,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

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

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Body

application/json

code

string

required

Required string length: 3

Example:

"EUR"

name

string

required

Example:

"Euro"

symbol

string | null

Example:

"EUR"

decimals

integer

default:2

is_active

boolean

default:true

metadata

object

Response

Currency created

A currency that the entity transacts in. USD is seeded on entity creation with is_base=true. Wave B multi-currency foundation: exchange_rates link non-base currencies to the base. Soft-delete refuses with HTTP 409 if the row is the entity's base currency; promote a different currency first via POST /currencies/{id}/set-base. Scope: currencies:read / currencies:write / currencies:delete. Rule 23 SSOT: is_base is flipped only by canonical setBaseCurrency (atomically demotes the previous base in the same transaction).

string<uuid>

read-only

object

string

Example:

"currency"

entity_id

string<uuid>

read-only

code

string

ISO 4217 currency code, UPPERCASE 3 letters.

Required string length: 3

Example:

"USD"

name

string

Human-readable currency name. 1..80 chars.

symbol

string | null

Display symbol. Optional; up to 8 chars.

decimals

integer

default:2

Display precision. JPY = 0, BHD = 3, most = 2.

is_active

boolean

default:true

is_base

boolean

default:false

True for exactly one currency per entity. Read-only; set via set-base.

metadata

object

Free-form caller metadata. Default {}.

deleted_at

string<date-time> | null

read-only

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

List currencies Retrieve a currency

Overview

All Endpoints

Create a currency

Authorizations

Headers

Body

Response