> ## 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.

# Coleção do Postman

Simplifique seus testes e integração de API com a coleção oficial do Postman da Localpayment. Essa coleção abrangente fornece solicitações pré-configuradas para todos os nossos endpoints, facilitando a exploração, o teste e a compreensão da nossa API sem precisar escrever nenhum código.

## O que é o Postman?

> [card] Plataforma de desenvolvimento de API
>
> O Postman é uma plataforma colaborativa para desenvolvimento de APIs que simplifica a criação, o teste e a documentação de APIs.

> [card] Testes sem código
>
> Teste visualmente os endpoints da API com solicitações, ambientes e fluxos de trabalho automatizados pré-configurados.

### Principais funcionalidades do Postman

* **Coleções**: Organize as solicitações de API em pastas e compartilhe-as com sua equipe.
* **Ambientes**: Gerencie diferentes configurações (teste vs. produção) com variáveis.
* **Testes automatizados**: escreva e execute testes para validar automaticamente as respostas da API.

> [!NOTE]
>
> **É novo no Postman?**
>
> [Baixe o Postman](https://www.postman.com/downloads/) gratuitamente e confira o [centro de aprendizagem](https://learning.postman.com/) para tutoriais completos.

***

## Comece a usar o Postman Collection

### Baixe a coleção

Obtenha a versão mais recente da nossa coleção Postman:

> [card] [Coleção do Postman](https://cdn.localpayment.com/public_docs/Postman/Postman%20Collection20241017.postman_collection)

### Importar para o Postman

**Opção 1: Importação direta**

* Clique no botão "Executar no Postman" acima.
* O Postman abrirá o arquivo e solicitará que você importe a coleção.

**Opção 2: Importação manual**

1. Abra o Postman
2. Clique em **Importar** no canto superior esquerdo.
3. Arraste e solte o arquivo JSON baixado ou selecione-o no seu computador.
4. Clique em **Importar** para adicionar a coleção ao seu espaço de trabalho.

### Configurar o ambiente

Importe nosso modelo de ambiente pré-configurado:

[Baixe o modelo de ambiente](https://cdn.localpayment.com/public_docs/Postman/V3%20-%20Enviroment-%20STAGE.postman_environment)

Isso inclui todas as variáveis necessárias para testes com as APIs do Localpayment.

***

## Configuração do ambiente

O ambiente Localpayment contém variáveis essenciais que precisam ser configuradas para seus cenários de teste. Atualize esses valores no seu ambiente Postman antes de fazer as requisições.

### Variáveis de ambiente

| Variável | Descrição | Valor de exemplo | Obrigatório |
| - | - | - | - |
| `accountNumber` | Número da conta Localpayment onde a operação é realizada. | `3.203.200.000.001` | Sim |
| `baseUrl` | URL do ambiente da API (teste ou produção) | `https://api.stage.localpayment.com` | Sim |
| `userName` | Nome de usuário para solicitações de geração de token | `your_username` | Sim |
| `password` | Senha para solicitações de geração de token | `your_password` | Sim |
| `accessToken` | Token de portador para autenticação da API (preenchido automaticamente a partir de solicitações de token) | `Bearer eyJhbGciOiJ...` | Não |
| `refreshToken` | Token de atualização para obtenção de novos tokens de acesso. | `eyJhbGciOiJ...` | Não |
| `country` | Código do país para operações (ISO 3166-1 alfa-3) | `MEX` | Sim |
| `externalId` | Identificador UUID4 gerado automaticamente pelo Postman. | `f47ac10b-58cc-4372-a567-0e02b2c3d479` | Não |
| `internalId` | Identificador interno da transação (preenchido automaticamente pelas respostas da API) | `0dcf3970-006a-46e8-b914-f3853abc3cf3` | Não |
| `currency` | Código de moeda para operações (ISO 4217) | `MXN` | Sim |
| `conceptCode` | Código de conceito predefinido da lista de conceitos do Localpayment | `0001` | Sim |

### Configure seu ambiente

1. No Postman, clique em **Ambientes** na barra lateral.
2. Selecione o **Ambiente Localpayment**
3. Atualize o **valor atual** de cada variável com suas credenciais reais.
4. Certifique-se de que o ambiente esteja selecionado no menu suspenso no canto superior direito.

***

## Estrutura da coleção

Nossa coleção Postman está organizada por produto e funcionalidade para facilitar a navegação:

```
Localpayment API
├── Before a payment
│ ├── Authentication
│ ├── Validation Services
│ └── Resources
├── Payins
│ ├── Cards
│ ├── Virtual Accounts
│ └── Subscriptions
├── Payouts
└── Treasury & FX
  ├── FX Services
  ├── Reports
  └── Transactions
```

***

## Recursos adicionais

> [card] [Referência da API](https://docs.localpayment.com/pt-br/reference)
>
> Documentação completa dos endpoints com exemplos de requisição/resposta e
> parâmetros

> [card] [Webhooks](https://docs.localpayment.com/pt-br/docs/webhooks.md)
>
> Configure e verifique os endpoints de webhook para notificações de eventos em tempo real.

> [card] [Centro de aprendizagem do Postman](https://learning.postman.com/)
>
> Documentação oficial do Postman, tutoriais e melhores práticas para testes de API.


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