# Super Pagamentos

## Docs

- [Autenticar conta](https://docs.superpagamentos.com/api-reference/endpoint/authentication/auth.md): A rota `/auth` gera tokens JWT com duração de 3600 segundos. Com esses tokens é possível autenticar as demais rotas da aplicação para.
- [Adicionar conta bancária](https://docs.superpagamentos.com/api-reference/endpoint/bank_accounts/create.md): Crie uma nova conta bancária para a empresa.
- [Remover conta bancária](https://docs.superpagamentos.com/api-reference/endpoint/bank_accounts/delete.md): Remove uma conta bancária específica que pertence à empresa cadastrada. Esta operação é irreversível e deve ser utilizada com cautela.
- [Detalhar conta bancária](https://docs.superpagamentos.com/api-reference/endpoint/bank_accounts/get.md): Busca os dados de uma conta bancária específica que pertence à empresa cadastrada. A resposta inclui informações detalhadas da conta, como dados do titular, dados bancários e status da conta.
- [Listar contas bancárias](https://docs.superpagamentos.com/api-reference/endpoint/bank_accounts/list.md): Lista todas as contas bancárias cadastradas para a empresa. A resposta inclui informações detalhadas de cada conta, como dados do titular, dados bancários e status da conta. Os resultados são paginados para melhor performance.
- [Remover token](https://docs.superpagamentos.com/api-reference/endpoint/cards/delete.md): Remove um cartão tokenizado específico. Esta operação é irreversível e deve ser utilizada com cautela. Após a remoção, o token não poderá mais ser utilizado para realizar transações.
- [Recuperar dados do cartão tokenizado](https://docs.superpagamentos.com/api-reference/endpoint/cards/get.md): Busca os dados de um cartão tokenizado específico. Esta rota retorna informações parciais do cartão (apenas os primeiros e últimos 4 dígitos) por questões de segurança, mantendo os dados sensíveis protegidos.
- [Tokenizar cartão de crédito](https://docs.superpagamentos.com/api-reference/endpoint/cards/tokenize.md): Tokeniza um cartão de crédito e o associa a um cliente específico. A tokenização é um processo de segurança que substitui os dados sensíveis do cartão por um token único e seguro. Este token pode ser utilizado para realizar compras futuras sem a necessidade de informar novamente os dados do cartão.
- [Adicionar cliente](https://docs.superpagamentos.com/api-reference/endpoint/customers/create.md): Cria um novo cliente no sistema. Nenhum campo é obrigatório, exceto os campos do endereço quando informado.
- [Remover cliente](https://docs.superpagamentos.com/api-reference/endpoint/customers/delete.md): Remove um cliente específico do sistema. Esta operação é irreversível e deve ser utilizada com cautela.
- [Detalhar cliente](https://docs.superpagamentos.com/api-reference/endpoint/customers/get.md): Busca os dados de um cliente específico. A resposta inclui informações detalhadas do cliente, como dados pessoais, contato e endereço.
- [Listar clientes](https://docs.superpagamentos.com/api-reference/endpoint/customers/list.md): Lista todos os clientes cadastrados. A resposta inclui informações detalhadas de cada cliente, como dados pessoais, contato e endereço. Os resultados são paginados para melhor performance.
- [Atualizar cliente](https://docs.superpagamentos.com/api-reference/endpoint/customers/update.md): Atualiza os dados de um cliente específico. Nenhum campo é obrigatório, exceto quando o cliente não possui um endereço cadastrado e deseja cadastrar um novo endereço - neste caso, todos os campos do endereço são obrigatórios.
- [Adicionar subconta PF](https://docs.superpagamentos.com/api-reference/endpoint/subaccounts/createpf.md): Cria uma nova subconta do tipo Pessoa Física. Com esta subconta, você poderá gerenciar contas bancárias, clientes, planos, assinaturas e realizar split de pagamentos de forma independente.
- [Adicionar subconta PJ](https://docs.superpagamentos.com/api-reference/endpoint/subaccounts/createpj.md): Cria uma nova subconta do tipo Pessoa Jurídica. Com esta subconta, você poderá gerenciar contas bancárias, clientes, planos, assinaturas e realizar split de pagamentos de forma independente.
- [Remover subconta](https://docs.superpagamentos.com/api-reference/endpoint/subaccounts/delete.md): Remove uma subconta específica. Esta operação é irreversível e deve ser utilizada com cautela.
- [Detalhar subconta](https://docs.superpagamentos.com/api-reference/endpoint/subaccounts/findone.md): Busca os dados de uma subconta específica que pertence à empresa cadastrada. A resposta inclui informações detalhadas da subconta, como dados do responsável legal, dados jurídicos (para PJ), endereços e status da conta.
- [Listar subcontas](https://docs.superpagamentos.com/api-reference/endpoint/subaccounts/listall.md): Lista todas as subcontas cadastradas para a empresa. A resposta inclui informações detalhadas de cada subconta, como dados do responsável legal, dados jurídicos (para PJ), endereços e status da conta. Os resultados são paginados para melhor performance.
- [Adicionar split na assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/addsplit.md): Adiciona um novo split para uma assinatura existente. O split pode ser configurado por valor fixo (amount) ou porcentagem (percentage) do valor da assinatura. É possível definir se a subconta será responsável pelos chargebacks da assinatura através do campo chargebackLiable.
- [Cancelar assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/cancel.md): Cancela uma assinatura existente. Após o cancelamento, a assinatura não poderá mais ser reativada.
- [Adicionar assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/create.md): Cria uma nova assinatura recorrente para um cliente. As assinaturas recorrentes permitem cobrar automaticamente um valor fixo em intervalos regulares, facilitando a gestão de pagamentos recorrentes.
- [Detalhar assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/get.md): Recupera os dados detalhados de uma assinatura específica. A resposta inclui informações como dados do cliente, valores, frequência, splits e status da assinatura.
- [Listar assinaturas](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/list.md): Lista todas as assinaturas da companhia. A resposta inclui informações detalhadas de cada assinatura, como dados do plano, splits e status. Os resultados são paginados para melhor performance.
- [Reativar assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/reactivate.md): Reativa uma assinatura que está suspensa. Ao reativar uma assinatura, os cobramentos automáticos serão retomados de acordo com o plano e periodicidade configurados.
- [Remover split da assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/removesplit.md): Remove um split específico de uma assinatura. Esta operação é irreversível e deve ser utilizada com cautela. Após a remoção do split, o valor total da assinatura será ajustado automaticamente.
- [Suspender assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/suspend.md): Suspende uma assinatura existente, interrompendo temporariamente as cobranças recorrentes. Esta operação é útil quando o cliente precisa de uma pausa temporária no serviço, mas deseja manter a assinatura para reativação futura.
- [Atualizar assinatura](https://docs.superpagamentos.com/api-reference/endpoint/subscriptions/update.md): Atualiza os dados de uma assinatura existente. Esta rota permite atualizar diversos campos da assinatura, exceto os dados de split. Para alterar os dados de split, é necessário utilizar a rota específica para isso.
- [Gerar transação](https://docs.superpagamentos.com/api-reference/endpoint/transactions/generatepayment.md): Cria uma nova transação no método de pagamento selecionado. Essa rota pode ser utilizada para criar transações com cartão de crédito, cartão tokenizado, PIX e boleto. Também é possível realizar splits entre subcontas.
- [Detalhar transação](https://docs.superpagamentos.com/api-reference/endpoint/transactions/get.md): Retorna os detalhes de uma transação específica pelo ID.
- [Listar transações](https://docs.superpagamentos.com/api-reference/endpoint/transactions/list.md): Lista todas as transações realizadas pela empresa autenticada. Esta rota suporta paginação e filtros para facilitar a busca de transações específicas.
- [Estornar transação](https://docs.superpagamentos.com/api-reference/endpoint/transactions/refund.md): Realiza o estorno de uma transação. É importante notar que:
- [Consultar saldos](https://docs.superpagamentos.com/api-reference/endpoint/withdrawals/balance.md): Retorna os saldos disponíveis para saque por tipo de transação
- [Detalha saque](https://docs.superpagamentos.com/api-reference/endpoint/withdrawals/get.md): Retorna os detalhes de um saque específico
- [Listar saques](https://docs.superpagamentos.com/api-reference/endpoint/withdrawals/list.md): Lista todas as solicitações de saque realizadas pela empresa autenticada.
- [Solicitar saque](https://docs.superpagamentos.com/api-reference/endpoint/withdrawals/withdraw.md): Cria uma nova solicitação de saque. O tipo de saque determina a estrutura específica dos dados necessários.
- [Introdução](https://docs.superpagamentos.com/api-reference/introduction.md): Bem-vindo à documentação da API da Super Pagamentos!   Nossa API foi desenvolvida para oferecer uma integração robusta, segura e intuitiva com a nossa plataforma de intermediação de pagamentos. Através dela, é possível criar e gerenciar subcontas, processar transações, tokenizar cartões, configurar…
- [Autenticação das APIs](https://docs.superpagamentos.com/guid-pages/authentication.md)
- [Cartões para Testes](https://docs.superpagamentos.com/guid-pages/card-test.md)
- [Nossos Ambientes](https://docs.superpagamentos.com/guid-pages/environments.md)
- [Guia de Erros](https://docs.superpagamentos.com/guid-pages/errors-guide.md)
- [Guia de Suporte](https://docs.superpagamentos.com/guid-pages/support-guide.md)
- [Gerando Boleto Bancário](https://docs.superpagamentos.com/guid-pages/transactions/create-billet-transaction.md)
- [Transação com Cartão de Crédito](https://docs.superpagamentos.com/guid-pages/transactions/create-card-transaction.md)
- [Gerando PIX Dinâmico](https://docs.superpagamentos.com/guid-pages/transactions/create-pix-transaction.md)
- [Políticas de Reembolso](https://docs.superpagamentos.com/guid-pages/transactions/refund.md)
- [Introdução](https://docs.superpagamentos.com/introduction.md): Bem-vindo a nossa documentação. Aqui você poderá aprender mais sobre o funcionamento das nossas API's, realizar testes e mais.

## OpenAPI Specs

- [openapi](https://docs.superpagamentos.com/api-reference/openapi.json)

## Optional

- [WhatsApp de Suporte](https://wa.me/+5527933001841)
- [Canal do Youtube](https://www.youtube.com/@superpagamentos)
- [Nosso Instagram](https://www.instagram.com/superpagamentos)