v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Asset Rates API

Create or Update an AssetRate

put/v1/organizations/{organization_id}/ledgers/{ledger_id}/asset-rates

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

ledger_idstring uuid required

The unique identifier of the associated Ledger.

Headers

Content-Typestring

The type of media of the resource. Recommended value is application/json.

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Request body

createdAtstring date-time required
externalIdstring uuid required
fromstring required
idstring uuid required
ledgerIdstring uuid required
metadataobject required
organizationIdstring uuid required
ratenumber double required
scalenumber double nullable required
sourcestring nullable required
tostring required
ttlinteger required
updatedAtstring date-time required

Example request

{
  "createdAt": "2021-01-01T00:00:00Z",
  "externalId": "00000000-0000-0000-0000-000000000000",
  "from": "USD",
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "rate": 100,
  "scale": 2,
  "source": "External System",
  "to": "BRL",
  "ttl": 3600,
  "updatedAt": "2021-01-01T00:00:00Z"
}

Response

OK

createdAtstring date-time required
externalIdstring uuid required
fromstring required
idstring uuid required
ledgerIdstring uuid required
metadataobject required
organizationIdstring uuid required
ratenumber double required
scalenumber double nullable required
sourcestring nullable required
tostring required
ttlinteger required
updatedAtstring date-time required

Example response

{
  "createdAt": "2021-01-01T00:00:00Z",
  "externalId": "00000000-0000-0000-0000-000000000000",
  "from": "USD",
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "rate": 100,
  "scale": 2,
  "source": "External System",
  "to": "BRL",
  "ttl": 3600,
  "updatedAt": "2021-01-01T00:00:00Z"
}