Loam Customer API · Preview

Developer Hub

Begin hier om te bouwen op de Loam Customer API.

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

Betalingen die u vandaag kunt inzien

Geef de betalingen van de organisatie weer met een bearer-token. Een lege pagina betekent succes — er is nog niets vastgelegd. Geld overmaken is een andere aanroep: daarvoor is de money.write scope vereist, een owner grant onder step-up-authenticatie en een goedgekeurde bestemming; in de preview blijft deze gesloten.

GET /api/v1/payments
curl -H "Authorization: Bearer $LOAM_TOKEN" \  "$LOAM_API_BASE/payments"// Response
{
  "ok": true,
  "data": [
    {
      "id": "c4d8e2f0-1a3b-45cd-8e9f-0a1b2c3d4e5f",
      "state": "settled",
      "source_kind": "wallet_transfer",
      "fiat_amount": 2500000,
      "fiat_currency": "USD",
      "crypto_amount": null,
      "crypto_currency": null,
      "trade_id": null,
      "created_at": "2026-07-14T09:12:04.118Z",
      "updated_at": "2026-07-14T09:14:11.004Z",
      "settled_at": "2026-07-14T09:14:11.004Z",
      "failed_at": null
    }
  ],
  "page": { "next_cursor": null }
}

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.