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 betaling, zoals de API die schrijft

Verstuur geld met amount en currency naar een goedgekeurde bestemming. De write geeft 202 terug met { id, state } en een Location. Het vereist de money.write scope, een owner grant onder step-up authenticatie, en blijft gesloten in preview.

POST /api/v1/payments
curl -X POST "$LOAM_API_BASE/payments" \  -H "Authorization: Bearer $LOAM_TOKEN" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: $(uuidgen)" \  -d '{    "destination_id": "2f4cbb59-3ab1-4b6d-8d10-9cd2236cf94e",    "amount": 2500000,    "currency": "USD"  }'// Response
HTTP/1.1 202 Accepted
Location: /api/v1/payments/<payment-id>

{
  "ok": true,
  "data": {
    "id": "<payment-id>",
    "state": "processing"
  }
}

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
  • Betalingen, opgesomd GET /api/v1/payments
  • 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