> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Noções básicas de API

Bem-vindo à documentação da API Localpayment. Nossa API REST permite que você integre recursos de processamento de pagamentos diretamente em seus aplicativos, sites e plataformas, com funcionalidades completas de Payin e Payout em toda a América Latina.

A API Localpayment oferece uma interface RESTful robusta para processar pagamentos e gerenciar operações financeiras. Desenvolvida com foco na experiência do desenvolvedor, nossa API apresenta URLs orientadas a recursos, formatos de solicitação/resposta JSON e convenções HTTP padrão para garantir uma integração perfeita em todas as plataformas e linguagens de programação.

> [card] Design RESTful
>
> Endpoints limpos e previsíveis, seguindo os princípios REST para facilitar a integração.

> [card] Formato JSON
>
> Formato JSON consistente para requisições e respostas em todos os endpoints.

> [card] Padrões HTTP
>
> Métodos HTTP padrão, códigos de status e autenticação.

***

## Fundamentos de API

Compreenda os conceitos e componentes principais da API Localpayment para criar integrações robustas.

> [card] [Autenticação](https://docs.localpayment.com/pt-br/reference/authentication-overview.md)
>
> Aprenda a gerar tokens de acesso e a autenticar requisições da API usando
> autenticação por token Bearer

> [card] [Solicitações e Respostas](https://docs.localpayment.com/pt-br/docs/error-handling.md)
>
> Compreenda o formato de requisição da API, a estrutura da resposta e os
> padrões comuns de resposta

> [card] [Códigos de erro](https://docs.localpayment.com/pt-br/reference/transaction-status-error-codes)
>
> Consulte códigos de erro abrangentes e estratégias de tratamento para falhas de API.

> [card] [Webhooks](https://docs.localpayment.com/pt-br/docs/webhooks.md)
>
> Implemente notificações em tempo real para eventos de transação e alterações de status.

***

## Ambientes

> [tab] Estágio
>
> Utilize nosso ambiente sandbox para testes e desenvolvimento sem processar transações reais.
>
> ### URLs base
>
> | Componente | URL |
> | - | - |
> | **URL base da API** | `https://api.stage.localpayment.com` |
> | **Painel** | `https://ui.stage.localpayment.com` |
>
> ### Características
>
> * Teste números de cartão e contas bancárias
> * Processamento de pagamento simulado
> * Teste de webhook
> * Nenhuma movimentação monetária real
> * Funcionalidade completa da API
>
> ### Começando
>
> 1. Crie uma conta Stage
> 2. Recupere suas credenciais de API no painel de controle.
> 3. Configure a lista de permissões de IP para segurança.
> 4. Comece a testar sua integração.

> [tab] Produção
>
> Acesse o ambiente de produção após concluir os testes e a certificação.
>
> ### URLs base
>
> | Componente | URL |
> | - | - |
> | **URL base da API** | `https://api.v3.localpayment.com` |
> | **Painel** | `https://ui.v3.localpayment.com` |
>
> ### Requisitos
>
> * Testes de integração concluídos no Stage
> * Revisão e certificação de segurança
> * Verificação comercial aprovada
> * Processamento de transações em tempo real
>
> ### Processo de entrada em operação
>
> 1. Realizar testes completos e minuciosos em ambiente de teste.
>
> 2. Submeter integração para revisão de segurança
>
> 3. Verificação completa da empresa
>
> 4. Receba as credenciais de produção.
>
> 5. Atualize seu aplicativo para usar URLs de produção.
>
> > [!TIP]
> >
> > **Pronto para a produção?**
> >
> > Entre em contato com nossa equipe de suporte para iniciar o processo de certificação assim que sua fase de testes for concluída.

***

## Início rápido

Comece a usar rapidamente com nossos recursos essenciais para iniciantes.

> [card] [Faça seu primeiro pagamento de teste](https://docs.localpayment.com/pt-br/docs/make-your-first-test-payment.md)
>
> Guia passo a passo para criar seu primeiro pagamento de teste no ambiente
> Stage, com código de exemplo

> [card] [Coleção do Postman](https://docs.localpayment.com/pt-br/reference/postman-collection.md)
>
> Baixe nossa coleção do Postman pré-configurada com todos os endpoints da API e
> cenários de teste

***

> [card] [Recursos de apoio](https://docs.localpayment.com/pt-br/docs)
>
> * [**Guia de integração:**](https://docs.localpayment.com/pt-br/docs) tutoriais passo a passo para cenários de integração comuns.
> * [**Suporte:**](mailto:support@localpayment.com) Suporte técnico para problemas de integração de API.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.