# UmbrellaPag

## Docs
- [🚀 Introdução à API](https://docs.umbrellapag.com/-introdu%C3%A7%C3%A3o-%C3%A0-api-1348891m0.md): 
- [📦 Criar Pedido](https://docs.umbrellapag.com/-criar-pedido-1348892m0.md): 
- Webhook [⚙️ Webhook: Formato de Postback](https://docs.umbrellapag.com/%EF%B8%8F-webhook-formato-de-postback-1348893m0.md): 

## API Docs
- My company [Get all data](https://docs.umbrellapag.com/get-all-data-20025728e0.md): Este endpoint permite listar toda informação vinculados ao usuário autenticado.  
- My company [Update](https://docs.umbrellapag.com/update-20025729e0.md): Este endpoint permite **atualizar as informações cadastrais** previamente registrado.  
- My company [Update documents](https://docs.umbrellapag.com/update-documents-20025730e0.md): Este endpoint permite **atualizar os documentos**.  
- My company [Get by ID](https://docs.umbrellapag.com/get-by-id-20025731e0.md): Este endpoint permite **consultar os dados completos ** específico, utilizando seu `id` como identificador.  
- My company [Update other info](https://docs.umbrellapag.com/update-other-info-20025732e0.md): Este endpoint permite **atualizar informações complementares**.  
- Products [Create](https://docs.umbrellapag.com/create-20025733e0.md): ## 📦 Criar Produto
- Products [Find All](https://docs.umbrellapag.com/find-all-20025734e0.md): ## 🛒 Consultar Produtos
- Products [Find by ID](https://docs.umbrellapag.com/find-by-id-20025735e0.md): ## 🛍️ Consultar Produto por ID
- Products [Update](https://docs.umbrellapag.com/update-20025736e0.md): ## 🔄 Atualizar Produto
- Products [Delete](https://docs.umbrellapag.com/delete-20025737e0.md): ## 🗑️ Deletar Produto
- Products [Update Status](https://docs.umbrellapag.com/update-status-20025738e0.md): ## 🔄 Atualizar Status do Produto
- Bank [Create](https://docs.umbrellapag.com/create-20025739e0.md): Este endpoint permite cadastrar uma conta bancária para um recebedor autenticado, que será utilizada para o repasse dos valores transacionados.
- Bank [Find all](https://docs.umbrellapag.com/find-all-20025740e0.md): Este endpoint permite consultar as contas bancárias cadastradas para o recebedor autenticado.
- Bank [Find by ID](https://docs.umbrellapag.com/find-by-id-20025741e0.md): Este endpoint permite consultar os detalhes de uma conta bancária específica cadastrada para o recebedor autenticado, utilizando o `ID` da conta.
- Bank [Find pre bank](https://docs.umbrellapag.com/find-pre-bank-20025742e0.md): Este endpoint retorna a lista de contas bancárias preliminares (pré-validadas ou em processo de cadastro) associadas ao usuário autenticado.
- Transactions [Find All](https://docs.umbrellapag.com/find-all-20025743e0.md): Este endpoint permite recuperar os detalhes de um webhook específico, a partir do seu identificador único (`id`).
- Transactions [Create](https://docs.umbrellapag.com/create-20025744e0.md): Este endpoint permite criar uma nova transação para o usuário autenticado, com todas as informações necessárias sobre pagamento, cliente, envio e itens da compra.
- Transactions [Find by ID](https://docs.umbrellapag.com/find-by-id-20025745e0.md): Este endpoint permite recuperar os detalhes de um webhook específico, a partir do seu identificador único (`id`).
- Transactions [Update delivery status](https://docs.umbrellapag.com/update-delivery-status-20025746e0.md): Este endpoint permite atualizar o status de entrega de uma transação específica, identificada por seu id. Também é possível registrar um código de rastreamento, se aplicável..
- Transactions [Export Excel](https://docs.umbrellapag.com/export-excel-20025747e0.md): Este endpoint permite exportar uma lista de transações do usuário autenticado em formato Excel (`.xlsx`). Suporta diversos filtros para personalizar os dados exportados, além de paginação e ordenação.
- Transactions [Summary all](https://docs.umbrellapag.com/summary-all-20025748e0.md): Este endpoint retorna um resumo estatístico das transações do usuário autenticado. Permite aplicar diversos filtros para análise de comportamento, volume financeiro, taxas e status das transações em determinado período ou conjunto de critérios.
- Transactions [Fee](https://docs.umbrellapag.com/fee-20025749e0.md): Este endpoint permite exportar uma lista de transações do usuário autenticado em formato Excel (`.xlsx`). Suporta diversos filtros para personalizar os dados exportados, além de paginação e ordenação.
- Transactions [Summary by ID](https://docs.umbrellapag.com/summary-by-id-20025750e0.md): Este endpoint retorna um resumo consolidado de uma transação específica, identificado pelo seu id. Ideal para exibir informações simplificadas de status, valores e principais dados do pagamento.
- Checkout > Layouts [Create Layout](https://docs.umbrellapag.com/create-layout-20025757e0.md): ## 🎨 Criar Layout de Checkout
- Checkout > Layouts [Find](https://docs.umbrellapag.com/find-20025758e0.md): Este endpoint permite listar os layouts configurados no checkout com base em filtros e paginação. A requisição deve ser feita utilizando o método `GET`, com os parâmetros enviados via query string.
- Checkout > Layouts [Update settings](https://docs.umbrellapag.com/update-settings-20025759e0.md): Este endpoint permite atualizar as configurações de um layout de checkout existente. A requisição deve ser feita utilizando o método `PUT`, com os dados enviados no formato `multipart/form-data`.
- Checkout > Layouts [Update status](https://docs.umbrellapag.com/update-status-20025760e0.md): Este endpoint permite atualizar o status de um layout de checkout existente. A requisição deve ser feita utilizando o método `PUT`, com os dados enviados no formato `application/json`.
- Checkout > Layouts [Find by ID](https://docs.umbrellapag.com/find-by-id-20025761e0.md): Este endpoint permite buscar um layout de checkout específico pelo seu ID. A requisição deve ser feita utilizando o método `GET`, com o parâmetro enviado via query string.
- Checkout [Find info](https://docs.umbrellapag.com/find-info-20025751e0.md): Este endpoint permite obter informações gerais sobre o domínio configurado no checkout. A requisição deve ser feita utilizando o método `GET`, e não exige parâmetros adicionais.
- Checkout [Create Order](https://docs.umbrellapag.com/create-order-20025752e0.md): ## 🛒 Criar Pedido
- Checkout [Find info order](https://docs.umbrellapag.com/find-info-order-20025753e0.md): ## 🛍️ Consultar Informações do Pedido de Checkout
- Checkout [Find payment methods by ID](https://docs.umbrellapag.com/find-payment-methods-by-id-20025754e0.md): ## 💳 Consultar Métodos de Pagamento do Pedido de Checkout
- Checkout [Create payment](https://docs.umbrellapag.com/create-payment-20025755e0.md): ## 💳 Realizar Pagamento do Pedido de Checkout
- Checkout [Find payment methods](https://docs.umbrellapag.com/find-payment-methods-20025756e0.md): Este endpoint permite listar os métodos de pagamento disponíveis no checkout. A requisição deve ser feita utilizando o método `GET`, e não requer parâmetros adicionais.
- Transfers [Create](https://docs.umbrellapag.com/create-20025762e0.md): Este endpoint permite realizar uma **transferência de valores** para uma conta previamente cadastrada por um recebedor autenticado.  
- Transfers [Update](https://docs.umbrellapag.com/update-20025763e0.md): Este endpoint permite **calcular a taxa (fee)** aplicada sobre uma transferência antes de sua execução.  
- Transfers [Find all](https://docs.umbrellapag.com/find-all-20025764e0.md): Este endpoint permite **listar as transferências realizadas** por um recebedor autenticado.  
- Transfers [Find by ID](https://docs.umbrellapag.com/find-by-id-20025765e0.md): Este endpoint permite **consultar os detalhes de uma transferência específica**, utilizando o seu identificador único (`id`).
- Transfers [summary](https://docs.umbrellapag.com/summary-20025766e0.md): Este endpoint permite **consultar um resumo geral das transferências** realizadas por um recebedor autenticado.  
- Cashout [Create](https://docs.umbrellapag.com/create-20025767e0.md): Este endpoint permite criar um saque para uma chave pix indicada.
- Cashout [Find all](https://docs.umbrellapag.com/find-all-20025768e0.md): Este endpoint permite **listar todos os cashouts** vinculados ao usuário autenticado.  
- Cashout [Find by ID](https://docs.umbrellapag.com/find-by-id-20025769e0.md): Este endpoint permite **consultar os detalhes de um cashout específico**, utilizando seu identificador único (`id`).
- Customers [Find all](https://docs.umbrellapag.com/find-all-20025770e0.md): Este endpoint permite **listar todos os clientes** vinculados ao recebedor autenticado.  
- Customers [Find by ID](https://docs.umbrellapag.com/find-by-id-20025771e0.md): Este endpoint permite **consultar os detalhes de um cliente específico**, utilizando seu identificador único (`id`).
-  Balance [Find](https://docs.umbrellapag.com/find-20025772e0.md): Este endpoint permite consultar o histórico de saldo do usuário autenticado. Ele retorna os registros das movimentações de saldo associadas ao usuário.
-  Balance [Summary](https://docs.umbrellapag.com/summary-20025773e0.md): Este endpoint permite consultar um resumo consolidado do saldo do usuário autenticado. Ele retorna informações agregadas, como o saldo atual, entradas e saídas totais.
-  Balance [Find finalcial reserve](https://docs.umbrellapag.com/find-finalcial-reserve-20025774e0.md): Este endpoint permite consultar as informações da reserva financeira do usuário autenticado. Ele retorna dados relacionados a valores reservados, disponíveis e totais vinculados à conta do usuário.
- Webhook [Create](https://docs.umbrellapag.com/create-20025775e0.md): Este endpoint permite ao usuário registrar um novo webhook, informando a URL de destino e o tipo de evento que deseja escutar.
- Webhook [Find all](https://docs.umbrellapag.com/find-all-20025776e0.md): Este endpoint permite consultar os webhooks cadastrados pelo usuário autenticado, com suporte a filtros de busca, paginação e ordenação.
- Webhook [Find by ID](https://docs.umbrellapag.com/find-by-id-20025777e0.md): Este endpoint permite recuperar os detalhes de um webhook específico, a partir do seu identificador único (`id`).
- Webhook [Update](https://docs.umbrellapag.com/update-20025778e0.md): Este endpoint permite atualizar os dados de um webhook previamente cadastrado.
- Webhook [Delete](https://docs.umbrellapag.com/delete-20025779e0.md): Este endpoint permite excluir um webhook previamente cadastrado, com base no seu identificador único (`id`).

## Schemas
- User > Transactions [POST /api/user/transactions](https://docs.umbrellapag.com/post-apiusertransactions-8614221d0.md):