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 API para uma resposta ativa: emita um token, consulte os saldos liquidados e depois use o fluxo do Marketplace quando essa funcionalidade estiver ativada. 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.

Uma primeira requisição

Uma chamada HTTPS com um token Bearer. A autenticação utiliza OAuth 2.0 (client credentials), portanto não há redirecionamento para tratar nem SDK para instalar.

GET /api/v1/balances
curl --fail-with-body --silent --show-error \  --header "Authorization: Bearer $LOAM_TOKEN" \  "$LOAM_API_BASE/balances" | jq# Response{  "ok": true,  "data": [    {      "account_id": "6f9619ff-8b86-d011-b42d-00c04fc964ff",      "balance": 4250000,      "currency": "USD",      "last_settled_at": "2026-07-14T09:12:04.118Z"    }  ]}

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

  • Negócios e suas faturas · Funcionalidade do Marketplace (404 a menos que ativada; requer pagamentos + faturação) GET /api/v1/trades
  • Saldos liquidados GET /api/v1/balances
  • Termos do cofre da tesouraria GET /api/v1/vaults
  • Listagens do Marketplace · Funcionalidade do Marketplace (404 a menos que ativada; requer pagamentos + faturação) GET /api/v1/listings
  • Ofertas, listadas e criadas · Funcionalidade do Marketplace (404 a menos que ativada; requer pagamentos + faturação) POST /api/v1/offers
  • 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