Loam Customer API · Aperçu

Hub développeurs

Commencez ici pour développer sur l'API client Loam.

Cinq minutes Démarrage rapide Passez d'un nouveau client API à une réponse en production : émettez un jeton, consultez les soldes réglés, puis demandez un devis de change. Le flux de la place de marché est inclus lorsque cette fonctionnalité est activée. Suivez le démarrage rapide OpenAPI 3.1 Référence API Lisez le contrat publié endpoint par endpoint — chaque scope, schéma de requête et de réponse, et code d'erreur, avec un générateur de requêtes pour chaque route. Ouvrez la référence API

Les deux voies nécessitent des identifiants. Commencez par créer un client API.

Paiements que vous pouvez consulter aujourd'hui

Listez les paiements de l'organisation avec un jeton Bearer. Une page vide est un succès — rien n'a encore été enregistré. L'envoi d'argent est un appel différent : il nécessite le scope money.write, un owner grant via une authentification renforcée, ainsi qu'une destination approuvée, et il reste fermé en mode aperçu.

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

Ce que l'API couvre aujourd'hui

L'accès en preview est volontairement plus restreint que le contrat publié. Tout ce qui suit est appelable maintenant ou indique l'autorisation qu'il attend.

Ouvrir dans l'aperçu Scopes read et write

  • Soldes réglés GET /api/v1/balances
  • Paiements répertoriés GET /api/v1/payments
  • Termes du coffre de trésorerie GET /api/v1/vaults
  • Cotations de change POST /api/v1/fx/quotes

Fermé en aperçu Scope money.write

  • Paiements vers une destination approuvée POST /api/v1/payments
  • Entrée de fonds depuis un compte bancaire POST /api/v1/onramp
  • Sortie de fonds vers un compte bancaire POST /api/v1/offramp
  • Dépôts et retraits du coffre de trésorerie POST /api/v1/vaults/…

Les mouvements de fonds nécessitent qu'un propriétaire humain de l'organisation autorise la portée via une authentification renforcée, définisse une limite par transaction et approuve la destination à l'avance. Ces endpoints restent fermés jusqu'à la fin de la preview.

Comportement de l'API

  • OAuth 2.0

    Flux client credentials

    Échangez un identifiant client et un secret contre un jeton bearer de courte durée avec une seule requête encodée en formulaire. Les scopes sont lus depuis le client à chaque requête, donc la restriction d'un scope s'applique immédiatement.

  • Enveloppe

    Un format pour chaque route

    Le succès est ok puis data ; l'échec est ok: false avec un code d'erreur lisible par machine.

  • Idempotence

    Les réessais ne coûtent rien

    Chaque écriture nécessite un Idempotency-Key. La même clé avec le même corps rejoue le premier résultat au lieu d'écrire deux fois.

  • Pagination

    Curseurs, pas d'offsets

    Les routes de liste renvoient page.next_cursor. Renvoyez-le comme cursor jusqu'à ce qu'il soit null.

Choisissez une voie depuis ici : le démarrage rapide si vous voulez d'abord une requête fonctionnelle, la référence si vous connaissez déjà l'appel dont vous avez besoin.

Suivez le démarrage rapide Ouvrir la référence de l'API