# Guias Raims

- [Visão geral](/br/): Encontre orientações para integrar a API e configurar os recursos da sua conta Raims.
- Agentes de IA
  - [Configurar agentes](/br/agentes): Prepare seu agente de IA para desenvolver integrações com a API da Raims.
  - [Claude Code + Raims](/br/agentes/claude-code): Agente no terminal para preparar e revisar sua integração com a API Raims.
  - [Codex + Raims](/br/agentes/codex): Agente da OpenAI para desenvolver e revisar sua integração Raims no terminal, no editor ou na nuvem.
  - [Cursor + Raims](/br/agentes/cursor): Editor com agente integrado para desenvolver sua integração Raims com contexto do projeto.
  - [GitHub Copilot + Raims](/br/agentes/github-copilot): Assistente no editor para planejar e escrever código de integração com a Raims.
  - [OpenCode + Raims](/br/agentes/opencode): Agente de terminal com escolha de provedor de IA para implementar sua integração Raims.
  - [Vibe + Raims](/br/agentes/vibe): Agente da Mistral no terminal para preparar código de backend conectado à Raims.
  - [Devin + Raims](/br/agentes/devin): Agente em nuvem para investigar seu repositório e preparar uma integração Raims revisável.
  - [Visual Studio Code + Raims](/br/agentes/visual-studio-code): Configure o agente no VS Code com instruções e documentação para integrar a Raims.
  - [Command Code + Raims](/br/agentes/command-code): Agente de terminal para planejar a integração Raims a partir do código da sua aplicação.
  - [Bionic + Raims](/br/agentes/bionic): Aplicativo da LM Studio com projetos e sessões para preparar sua integração Raims.
- [Changelog](/br/changelog)
- Raims CLI
  - [Raims CLI](/br/cli): Use a API pública pelo terminal, configure perfis e execute integrações com o Raims CLI.
  - [Instalação direta](/br/cli/direct-installation): Instale o executável nativo do Raims CLI e controle as atualizações da sua instalação.
  - [Configuração e perfis](/br/cli/configuration): Guarde referências a credenciais e selecione um perfil por comando ou variável de ambiente.
  - [CI e automação](/br/cli/automation): Execute comandos sem interação, capture JSON e trate os códigos de saída do Raims CLI.
  - [Diagnóstico](/br/cli/diagnostics): Verifique a instalação com raims doctor e consulte o acesso à API com auth check.
  - [Referência dos comandos](/br/cli/reference): Consulte a sintaxe e as opções dos comandos do Raims CLI.
  - Comandos da API
    - [raims accounts](/br/cli/commands/accounts): Consulte os dados da conta e configure a aparência do checkout.
    - [raims balances](/br/cli/commands/balances): Consulte os saldos e os recebimentos previstos.
    - [raims charges](/br/cli/commands/charges): Gerencie as cobranças e seus dados de pagamento.
    - [raims customers](/br/cli/commands/customers): Gerencie os clientes.
    - [raims disputes](/br/cli/commands/disputes): Consulte as contestações.
    - [raims payment-links](/br/cli/commands/payment-links): Gerencie os links de pagamento.
    - [raims refunds](/br/cli/commands/refunds): Consulte os estornos e seus comprovantes.
    - [raims simulations](/br/cli/commands/simulations): Execute as simulações permitidas pela API para a credencial selecionada.
    - [raims statements](/br/cli/commands/statements): Consulte os lançamentos do extrato.
    - [raims webhook-event-types](/br/cli/commands/webhook-event-types): Consulte os tipos de evento aceitos nos webhooks.
    - [raims webhooks](/br/cli/commands/webhooks): Gerencie os webhooks.
    - [raims withdrawal-destinations](/br/cli/commands/withdrawal-destinations): Consulte os destinos de saque.
    - [raims withdrawals](/br/cli/commands/withdrawals): Consulte e solicite saques.
- Tipos e identificadores
  - [Tipos e identificadores](/br/tipos-e-identificadores): Encontre o significado dos identificadores, tipos e estados usados pela Raims.
  - [Identificadores e prefixos](/br/tipos-e-identificadores/identificadores): Saiba a que recurso cada identificador pertence e diferencie IDs de credenciais.
  - [Tipos do extrato e códigos financeiros](/br/tipos-e-identificadores/financeiro): Entenda statement_type, reference_type e os meios de pagamento retornados pela API.
  - [Estados e resultados](/br/tipos-e-identificadores/estados): Interprete os estados de cobranças, estornos e contestações sem confundir andamento e resultado financeiro.
- Integrações
  - [Autenticação](/br/integracoes/autenticacao): Use uma chave de API na integração ou autorize o Raims CLI pelo navegador.
  - [SDKs oficiais](/br/integracoes/sdks): Escolha o SDK da sua linguagem e consulte a instalação, os requisitos e os exemplos da API pública.
  - [SDK .NET](/br/integracoes/sdk-dotnet): Instale o SDK oficial e integre seu backend C# à API pública da Raims.
  - [SDK PHP](/br/integracoes/sdk-php): Instale o SDK oficial pelo Composer e integre seu backend PHP à API pública da Raims.
  - [SDK Go](/br/integracoes/sdk-go): Instale o SDK oficial Go e integre seu backend à API pública da Raims.
  - [SDK Java](/br/integracoes/sdk-java): Instale o SDK oficial Java e integre seu backend à API pública da Raims.
  - [SDK Python](/br/integracoes/sdk-python): Instale o SDK oficial Python e integre seu backend à API pública da Raims.
  - [SDK Node.js](/br/integracoes/sdk-node): Instale o SDK oficial Node.js e integre seu backend à API pública da Raims.
  - [SDK Ruby](/br/integracoes/sdk-ruby): Instale o SDK oficial Ruby pelo RubyGems e integre seu backend à API pública.
  - [SDK Elixir](/br/integracoes/sdk-elixir): Instale pelo Hex e integre aplicações Elixir à API pública com os módulos oficiais.
  - [SDK Rust](/br/integracoes/sdk-rust): Instale pelo crates.io e use serviços tipados no seu backend Rust com Tokio.
  - [SDK Delphi](/br/integracoes/sdk-delphi): Adicione os fontes ao projeto Delphi e configure serviços, paginação e webhooks no seu backend.
  - [Aplicativos autorizados](/br/integracoes/aplicativos): Conecte aplicativos à sua conta Raims e controle as permissões concedidas.
  - [MCP da Raims](/br/integracoes/mcp): Conecte um aplicativo de IA à sua conta com acesso aos ambientes permitidos e às operações autorizadas.
  - [Chaves de API](/br/integracoes/chaves-api): Crie, proteja e gerencie as credenciais de integração pelo Dashboard.
  - [Rate limiting](/br/integracoes/rate-limiting): Controle a frequência e a concorrência das chamadas à API Raims e trate respostas 429 com novas tentativas limitadas.
  - [Validação de CPF e CNPJ](/br/integracoes/validacao-cpf-cnpj): Valide o formato e os dígitos verificadores antes de enviar tax_id e saiba como tratar INVALID_TAXID.
  - Webhooks
    - [Webhooks](/br/integracoes/webhooks): Receba eventos da Raims por HTTPS e configure destinos, eventos e segredos no Dashboard.
    - [Receber e validar webhooks](/br/integracoes/webhooks/receber-eventos): Valide a assinatura dos webhooks e processe notificações com segurança, inclusive quando houver reentrega.
    - [IPs oficiais dos webhooks da Raims](/br/integracoes/webhooks/ips-oficiais): Autorize as origens dos webhooks da Raims no firewall, WAF ou proxy do seu endpoint.
- Financeiro
  - [Saques](/br/financeiro/saques): Entenda o saldo disponível, a chave Pix de destino, os limites, a tarifa e o acompanhamento do saque.
  - [Saques automáticos](/br/financeiro/saques-automaticos): Configure a tentativa diária de saque para a chave Pix verificada da empresa.
- [Meios de pagamento](/br/meios-de-pagamento): Conheça os meios de pagamento da Raims e os códigos usados nas cobranças da API.
- [Checkout e formas de pagamento](/br/checkout): Entenda como os meios de pagamento padrão da conta são aplicados ao checkout e como configurar suas opções.
- [Usuários e permissões](/br/usuarios-e-permissoes): Entenda cada permissão, os perfis sugeridos e os limites para administrar o acesso da equipe.

# Raims guides

- [Overview](/en/): Find guidance for integrating the API and configuring your Raims account.
- AI agents
  - [Agent setup](/en/agentes): Prepare your AI coding agent to build integrations with the Raims API.
  - [Claude Code + Raims](/en/agentes/claude-code): A terminal agent for planning and reviewing your Raims API integration.
  - [Codex + Raims](/en/agentes/codex): OpenAI's coding agent for building and reviewing your Raims integration in the terminal, editor, or cloud.
  - [Cursor + Raims](/en/agentes/cursor): An editor with a built-in agent for developing your Raims integration with project context.
  - [GitHub Copilot + Raims](/en/agentes/github-copilot): An editor assistant for planning and writing Raims integration code.
  - [OpenCode + Raims](/en/agentes/opencode): A terminal agent with a choice of AI providers for implementing your Raims integration.
  - [Vibe + Raims](/en/agentes/vibe): Mistral's terminal agent for preparing backend code that connects to Raims.
  - [Devin + Raims](/en/agentes/devin): A cloud agent for investigating your repository and preparing a Raims integration for review.
  - [Visual Studio Code + Raims](/en/agentes/visual-studio-code): Set up the VS Code agent with instructions and documentation for your Raims integration.
  - [Command Code + Raims](/en/agentes/command-code): A terminal agent for planning a Raims integration from your application code.
  - [Bionic + Raims](/en/agentes/bionic): An LM Studio application with projects and sessions for preparing your Raims integration.
- [Changelog](/en/changelog)
- Raims CLI
  - [Raims CLI](/en/cli): Use the public API from your terminal, configure profiles, and run integrations with Raims CLI.
  - [Direct installation](/en/cli/direct-installation): Install the native Raims CLI executable and control updates for your installation.
  - [Configuration and profiles](/en/cli/configuration): Store credential references and select a profile through a command option or environment variable.
  - [CI and automation](/en/cli/automation): Run commands without interaction, capture JSON, and handle Raims CLI exit codes.
  - [Diagnostics](/en/cli/diagnostics): Check your installation with raims doctor and API access with auth check.
  - [Command reference](/en/cli/reference): Look up syntax and options for Raims CLI commands.
  - API commands
    - [raims accounts](/en/cli/commands/accounts): Inspect account details and configure checkout appearance
    - [raims balances](/en/cli/commands/balances): Inspect balances and expected receivables
    - [raims charges](/en/cli/commands/charges): Manage charges and their payment details
    - [raims customers](/en/cli/commands/customers): Manage customers
    - [raims disputes](/en/cli/commands/disputes): Inspect disputes
    - [raims payment-links](/en/cli/commands/payment-links): Manage payment links
    - [raims refunds](/en/cli/commands/refunds): Inspect refunds and receipts
    - [raims simulations](/en/cli/commands/simulations): Simulate operations allowed by the API for the selected credential
    - [raims statements](/en/cli/commands/statements): Inspect account statement entries
    - [raims webhook-event-types](/en/cli/commands/webhook-event-types): Inspect supported webhook event types
    - [raims webhooks](/en/cli/commands/webhooks): Manage webhook endpoints
    - [raims withdrawal-destinations](/en/cli/commands/withdrawal-destinations): Inspect withdrawal destinations
    - [raims withdrawals](/en/cli/commands/withdrawals): Inspect and request withdrawals
- Types and identifiers
  - [Types and identifiers](/en/tipos-e-identificadores): Find the meaning of the identifiers, types, and statuses used by Raims.
  - [Identifiers and prefixes](/en/tipos-e-identificadores/identificadores): Learn which resource each identifier belongs to and distinguish IDs from credentials.
  - [Statement types and financial codes](/en/tipos-e-identificadores/financeiro): Understand statement_type, reference_type, and the payment methods returned by the API.
  - [Statuses and results](/en/tipos-e-identificadores/estados): Interpret charge, refund, and dispute statuses while distinguishing progress from financial results.
- Integrations
  - [Authentication](/en/integracoes/autenticacao): Use an API key in your integration or authorize Raims CLI through your browser.
  - [Official SDKs](/en/integracoes/sdks): Choose an SDK for your language and find installation steps, requirements, and public API examples.
  - [.NET SDK](/en/integracoes/sdk-dotnet): Install the official SDK and connect your C# backend to the Raims public API.
  - [PHP SDK](/en/integracoes/sdk-php): Install the official SDK through Composer and connect your PHP backend to the Raims public API.
  - [Go SDK](/en/integracoes/sdk-go): Install the official Go SDK and connect your backend to the Raims public API.
  - [Java SDK](/en/integracoes/sdk-java): Install the official Java SDK and connect your backend to the Raims public API.
  - [Python SDK](/en/integracoes/sdk-python): Install the official Python SDK and connect your backend to the Raims public API.
  - [Node.js SDK](/en/integracoes/sdk-node): Install the official Node.js SDK and connect your backend to the Raims public API.
  - [Ruby SDK](/en/integracoes/sdk-ruby): Install the official Ruby SDK from RubyGems and connect your backend to the public API.
  - [Elixir SDK](/en/integracoes/sdk-elixir): Install through Hex and connect Elixir applications to the public API with the official modules.
  - [Rust SDK](/en/integracoes/sdk-rust): Install from crates.io and use typed services in your Rust backend with Tokio.
  - [Delphi SDK](/en/integracoes/sdk-delphi): Add the source to your Delphi project and configure services, pagination, and webhooks in your backend.
  - [Authorized applications](/en/integracoes/aplicativos): Connect applications to your Raims account and control the permissions you grant.
  - [Raims MCP](/en/integracoes/mcp): Connect an AI application to your account with access to permitted environments and authorized operations.
  - [API keys](/en/integracoes/chaves-api): Create, protect, and manage integration credentials in the Dashboard.
  - [Rate limiting](/en/integracoes/rate-limiting): Control the rate and concurrency of Raims API calls and handle 429 responses with bounded retries.
  - [CPF and CNPJ validation](/en/integracoes/validacao-cpf-cnpj): Validate the format and check digits before sending tax_id and learn how to handle INVALID_TAXID.
  - Webhooks
    - [Webhooks](/en/integracoes/webhooks): Receive Raims events over HTTPS and configure destinations, events, and secrets in the Dashboard.
    - [Receive and validate webhooks](/en/integracoes/webhooks/receber-eventos): Validate webhook signatures and process notifications safely, including redeliveries.
    - [Official Raims webhook IPs](/en/integracoes/webhooks/ips-oficiais): Allow Raims webhook sources through the firewall, WAF, or proxy protecting your endpoint.
- Finance
  - [Withdrawals](/en/financeiro/saques): Understand the available balance, destination Pix key, limits, fee, and withdrawal tracking.
  - [Automatic withdrawals](/en/financeiro/saques-automaticos): Configure a daily withdrawal attempt to the company's verified Pix key.
- [Payment methods](/en/meios-de-pagamento): Learn about Raims payment methods and the codes used in API charges.
- [Checkout and payment methods](/en/checkout): Understand how the account's default payment methods apply to checkout and how to configure its options.
- [Users and permissions](/en/usuarios-e-permissoes): Understand each permission, the suggested profiles, and the limits for managing team access.