Pular para o conteúdo principal
A referência é agrupada por serviço. Cada serviço é uma API separada com sua própria URL base, listada em cada página de endpoint:

​
Autenticação

A menos que um endpoint indique o contrário, toda requisição exige um token JWT bearer emitido pelo serviço Identity:
Consulte o Início rápido para saber como obter e renovar tokens. Alguns endpoints não recebem um token bearer — por exemplo, POST /auth/sign-in (que recebe as credenciais do seu cliente de API via HTTP Basic), verificações de saúde de serviço (GET /health) e as páginas de checkout hospedadas para links de pagamento. Algumas operações sensíveis também exigem o PIN de transação do usuário em um cabeçalho pin — consulte Autenticação na introdução.

​
Paginação

Os endpoints de listagem retornam uma página por vez: items mais um cursor next, que é null na última página. Consulte Paginação.

​
Multi-tenancy

Endpoints cujo caminho começa com /realms/{realmId}/organizations/{organizationId}/ têm escopo de tenant: o token que você envia deve pertencer àquele realm e ter permissão para aquela organização. Seus IDs são fornecidos durante o onboarding.

​
Serviços

Não sabe por onde começar? Billing gerencia o ciclo de vida de acordos e faturas entre você e suas contrapartes; Payment Links & Checkout é para coletar pagamentos avulsos por meio de uma página hospedada; Banking é onde o dinheiro efetivamente se movimenta (PIX, boleto, carteiras, cartões).