Loam Customer API · Preview

Developer Hub

Begin hier om te bouwen op de Loam Customer API.

Vijf minuten Quickstart Ga van een nieuwe API-client naar een live-respons: mint een token, lees afgehandelde saldi en vraag daarna een valutawisselofferte aan. De marktplaatsflow is inbegrepen wanneer die functionaliteit is ingeschakeld. Volg de quickstart OpenAPI 3.1 API-referentie Lees het gepubliceerde contract endpoint voor endpoint — elke scope, request- en response-schema, en foutcodes, met een request-builder voor elke route. Open de API-referentie

Beide paden hebben referenties nodig. Begin met het aanmaken van een API-client.

Een eerste offerte

Een HTTPS-write met een bearer-token en een idempotency-key. De offerte blokkeert een aanbiederskoers — 10,000 USD minor units naar 9,125 EUR in het voorbeeld — en verplaatst geen geld.

POST /api/v1/fx/quotes
curl --fail-with-body --silent --show-error \  --request POST "$LOAM_API_BASE/fx/quotes" \  --header "Authorization: Bearer $LOAM_TOKEN" \  --header "Content-Type: application/json" \  --header "Idempotency-Key: $(uuidgen | tr '[:upper:]' '[:lower:]')" \  --data '{"from_currency":"USD","to_currency":"EUR","amount":10000}'// Response
HTTP/1.1 202 Accepted
Location: /api/v1/fx/quotes/a6bbdbeb-ed3b-42cb-85b1-af3112f2fe06

{
  "ok": true,
  "data": {
    "id": "a6bbdbeb-ed3b-42cb-85b1-af3112f2fe06",
    "from_amount": 10000,
    "from_currency": "USD",
    "to_amount": 9125,
    "to_currency": "EUR",
    "rate_decimal": "0.9125",
    "fee_amount": -25,
    "fee_currency": "USD",
    "expires_at": "2099-08-14T16:35:00.000Z",
    "state": "active"
  }
}

Wat de API vandaag dekt

Preview-toegang is opzettelijk beperkter dan het gepubliceerde contract. Alles hieronder is nu aanroepbaar of vermeldt welke machtiging het nog verwacht.

Openen in preview Scopes read en write

  • Afgewikkelde saldi GET /api/v1/balances
  • Voorwaarden voor de treasury-kluis GET /api/v1/vaults
  • Wisselkoersen POST /api/v1/fx/quotes

Gesloten in preview Scope money.write

  • Betalingen naar een goedgekeurde bestemming POST /api/v1/payments
  • Ontvangst van gelden vanaf een bankrekening POST /api/v1/onramp
  • Uitgaande betalingen naar een bankrekening POST /api/v1/offramp
  • Stortingen en opnames in de kluis POST /api/v1/vaults/…

Geldverplaatsingen vereisen dat een menselijke eigenaar van de organisatie de scope verleent onder step-up-authenticatie, een limiet per transactie instelt en de bestemming vooraf goedkeurt. Die eindpunten blijven gesloten totdat de preview eindigt.

Hoe de API zich gedraagt

  • OAuth 2.0

    Client credentials-grant

    Ruil een client-id en secret in voor een kortlevende bearer-token met één form-gecodeerd verzoek. Scopes worden per verzoek uit de client gelezen, dus het vernauwen van een scope geldt direct.

  • Envelop

    Één vorm voor elke route

    Succes is ok en daarna data; fout is ok: false met een machinaal leesbare foutcode.

  • Idempotentie

    Herhalingen kosten niets

    Elke schrijfactie vereist een Idempotency-Key. Dezelfde key met dezelfde body geeft het eerste resultaat terug in plaats van twee keer te schrijven.

  • Paginering

    Cursors, geen offsets

    Lijstroutes geven page.next_cursor terug. Geef het terug als cursor totdat het null wordt.

Kies vanaf hier een pad: de quickstart als je eerst een werkend verzoek wilt, de referentie als je de benodigde aanroep al kent.

Volg de quickstart Open de API-referentie