Loam Customer API · Vorschau

Entwickler-Hub

Beginnen Sie hier, um auf der Loam Customer API aufzubauen.

Fünf Minuten Schnellstart Wechseln Sie von einem neuen API-Client zu einer Live-Antwort: erstellen Sie einen Token, lesen Sie abgewickelte Salden und fordern Sie dann ein Devisenangebot an. Der Marktplatz‑Ablauf ist enthalten, wenn diese Funktion aktiviert ist. Folgen Sie dem Schnellstart OpenAPI 3.1 API-Referenz Lesen Sie den veröffentlichten Contract Endpunkt für Endpunkt — alle Scopes, Request- und Response‑Schemata sowie Fehlercodes, mit einem Request‑Builder für jede Route. API-Referenz öffnen

Beide Pfade benötigen Zugangsdaten. Beginnen Sie mit dem Erstellen eines API-Clients.

Ein erstes Angebot

Eine HTTPS‑Schreiboperation mit einem Bearer‑Token und einem Idempotenz‑Schlüssel. Das Angebot sichert einen Anbieterwechselkurs — in dem Beispiel 10.000 USD in den kleinsten Währungseinheiten zu 9.125 EUR — und es werden keine Gelder bewegt.

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"
  }
}

Was die API heute abdeckt

Der Preview‑Zugang ist bewusst enger gefasst als der veröffentlichte Kontrakt. Alles unten ist jetzt aufrufbar oder nennt die Berechtigung, auf deren Erteilung noch gewartet wird.

In Vorschau öffnen Scopes read und write

  • Abgewickelte Salden GET /api/v1/balances
  • Begriffe zum Treasury‑Vault GET /api/v1/vaults
  • Devisenkurse POST /api/v1/fx/quotes

In Vorschau geschlossen Scope money.write

  • Zahlungen an ein genehmigtes Ziel POST /api/v1/payments
  • Geldeingang von einem Bankkonto POST /api/v1/onramp
  • Auszahlungen auf ein Bankkonto POST /api/v1/offramp
  • Ein- und Auszahlungen im Vault POST /api/v1/vaults/…

Geldbewegungen erfordern, dass der menschliche Organisationsinhaber den Scope unter Step‑Up‑Authentifizierung gewährt, ein Transaktionslimit setzt und das Ziel im Voraus genehmigt. Diese Endpunkte bleiben geschlossen, bis die Vorschau endet.

Wie sich die API verhält

  • OAuth 2.0

    Client‑Credentials‑Grant

    Tauschen Sie eine Client‑ID und ein Secret gegen ein kurzlebiges Bearer‑Token mit einer formkodierten Anfrage aus. Scopes werden pro Anfrage aus dem Client gelesen, sodass eine Einschränkung sofort wirkt.

  • Umschlag

    Eine einheitliche Struktur für jede Route

    Erfolg ist ok dann data; Fehler ist ok: false mit einem maschinenlesbaren Fehlercode.

  • Idempotenz

    Wiederholungen kosten nichts

    Jeder Schreibvorgang erfordert einen Idempotency-Key. Derselbe Schlüssel mit demselben Body gibt das erste Ergebnis erneut zurück, anstatt zweimal zu schreiben.

  • Paginierung

    Cursors statt Offsets

    List‑Routen liefern page.next_cursor. Geben Sie es als cursor zurück, bis es null ist.

Wählen Sie einen Weg von hier: den Schnellstart, wenn Sie zuerst eine funktionierende Anfrage vor sich haben möchten; die Referenz, wenn Sie bereits wissen, welchen Aufruf Sie benötigen.

Folgen Sie dem Schnellstart API-Referenz öffnen