Loam Customer API · Pré-visualização

Developer Hub

Comece aqui para construir sobre a Loam Customer API.

Cinco minutos Quickstart Passe de um novo cliente de API para uma resposta em tempo real: cunhe um token, consulte saldos liquidados e solicite uma cotação de câmbio. O fluxo do marketplace é incluído quando essa funcionalidade estiver habilitada. Siga o início rápido OpenAPI 3.1 Referência da API Leia o contrato publicado endpoint por endpoint — cada escopo, esquema de requisição e resposta e código de erro, com um construtor de requisições para cada rota. Abra a referência da API

Ambos os caminhos exigem credenciais. Comece por criar um cliente de API.

Pagamentos que pode consultar hoje

Liste os pagamentos da organização com um token Bearer. Uma página vazia indica sucesso — nada foi registrado ainda. Enviar dinheiro é uma chamada diferente: requer o escopo money.write, uma concessão do titular sob autenticação step-up e um destino aprovado; além disso, permanece indisponível no modo de pré-visualização.

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

O que a API cobre hoje

O acesso de pré-visualização é deliberadamente mais restrito que o contrato publicado. Tudo abaixo pode ser chamado agora ou indica a concessão que está aguardando.

Abrir na pré-visualização Escopos read e write

  • Saldos liquidados GET /api/v1/balances
  • Pagamentos, listados GET /api/v1/payments
  • Termos do cofre da tesouraria GET /api/v1/vaults
  • Cotações de câmbio POST /api/v1/fx/quotes

Fechado na pré-visualização Escopo money.write

  • Pagamentos para um destino aprovado POST /api/v1/payments
  • Entradas de fundos de uma conta bancária POST /api/v1/onramp
  • Saídas de fundos para uma conta bancária POST /api/v1/offramp
  • Depósitos e retiradas no cofre POST /api/v1/vaults/…

Movimentação de dinheiro exige que o proprietário humano da organização conceda o escopo mediante autenticação com elevação, defina um limite por transação e aprove o destino com antecedência. Esses endpoints permanecem fechados até o fim da pré-visualização.

Como a API se comporta

  • OAuth 2.0

    Fluxo de credenciais do cliente

    Troque um ID e segredo de cliente por um token Bearer de curta duração com uma única requisição codificada em form. Os escopos são lidos do cliente por requisição, portanto restringir um aplica-se imediatamente.

  • Envelope

    Um formato para todas as rotas

    Sucesso é ok depois data; falha é ok: false com um código de erro legível por máquina.

  • Idempotência

    Retentativas não custam nada

    Cada escrita requer um Idempotency-Key. A mesma chave com o mesmo corpo reproduz o primeiro resultado em vez de gravar duas vezes.

  • Paginação

    Cursores, não offsets

    Rotas de listagem retornam page.next_cursor. Envie-o de volta como cursor até que retorne nulo.

Escolha um caminho: o início rápido se quiser primeiro uma requisição funcional, a referência se já souber a chamada de que precisa.

Siga o início rápido Abrir a referência da API