# Transfeera Documentation

> Nossa plataforma open banking automatiza sua rotina de gestão e processamento de pagamentos, reduzindo seu esforço operacional e aumentando sua eficiência.

## Guides
- [Introdução](https://docs.transfeera.dev/docs/comece-por-aqui-introducao.md): Aqui você irá encontrar toda a documentação relacionada a API da Transfeera. Abaixo segue algumas orientações gerais sobre a utilização dos nossos produtos.
- [Sandbox](https://docs.transfeera.dev/docs/comece-por-aqui-sandbox.md)
- [Documentos para testes](https://docs.transfeera.dev/docs/comece-por-aqui-documentos-para-testes.md): Relação de documentos para a realização de testes em Sandbox.
- [Chaves Pix](https://docs.transfeera.dev/docs/comece-por-aqui-chaves-pix.md): Relação de chaves Pix para a realização de testes em Sandbox.
- [Pix Automático](https://docs.transfeera.dev/docs/pix-automatico.md): Relação de documentos para a realização de testes em Sandbox.
- [Run in Postman](https://docs.transfeera.dev/docs/comece-por-aqui-run-in-postman.md): Criamos uma collection no Postman para que fique claro os endpoints e os possíveis erros que retornam na nossa API.
- [Suporte](https://docs.transfeera.dev/docs/comece-por-aqui-suporte.md)
- [Segurança](https://docs.transfeera.dev/docs/segurança.md)
- [Introdução](https://docs.transfeera.dev/docs/autenticacao-introducao.md)
- [Habilitar mTLS em produção](https://docs.transfeera.dev/docs/habilitar-mtls-em-produção.md)
- [Como funciona](https://docs.transfeera.dev/docs/pagamentos-lotes-como-funciona.md): Adotamos um modelo de criação de pagamentos por lote, onde você pode nos enviar um ou até no  5.000 pagamentos dentro de um mesmo lote. Dessa forma é possível organizar melhor os seus pagamentos e também otimizar a carga de pagamentos podendo enviar mais de um pagamento usando uma mesma requisição.
- [Status do lote](https://docs.transfeera.dev/docs/pagamentos-lotes-status-do-lote.md)
- [Como funciona](https://docs.transfeera.dev/docs/pagamento-transferencias-como-funciona.md): Utilizando os endpoints da nossa API de transferências, você pode fazer a gestão dos pagamentos criados, em processamento e finalizados, assim como receber alertas via webhooks e acessar os comprovantes de pagamento.
- [Status da transferência](https://docs.transfeera.dev/docs/pagamentos-transferencia-status-da-transferência.md)
- [Como funciona](https://docs.transfeera.dev/docs/pagamentos-boletos-como-funciona.md): Nossa API de Boletos concentra os endpoints para gestão de liquidação de boletos, possibilitando a consulta de informações direto da Núclea (antiga CIP) até a liquidação de boletos simples e de arrecadação/convênios.
- [Status do boleto](https://docs.transfeera.dev/docs/status-do-boleto.md)
- [Introdução](https://docs.transfeera.dev/docs/recebimentos-introducao.md)
- [Como funciona](https://docs.transfeera.dev/docs/recebimentos-chaves-pix-como-funciona.md)
- [Status das chaves](https://docs.transfeera.dev/docs/recebimentos-chaves-pix-status-da-chaves.md)
- [Como funciona](https://docs.transfeera.dev/docs/recebimentos-qrcode-pix-como-funciona.md)
- [Status dos QR Code](https://docs.transfeera.dev/docs/recebimentos-qrcode-pix-status-dos-qr-code.md)
- [Como funciona](https://docs.transfeera.dev/docs/como-funciona.md): Utilizando os endpoints da nossa API de recebimento de boleto, você pode dar aos seus clientes a opção de como pagar, seja através de Pix ou código de barras.
- [Status dos recebimentos](https://docs.transfeera.dev/docs/status-dos-boletos-com-qrcode.md)
- [Como funciona](https://docs.transfeera.dev/docs/pix-automatico-como-funciona.md)
- [Jornadas](https://docs.transfeera.dev/docs/pix-automatico-jornadas.md)
- [Introdução](https://docs.transfeera.dev/docs/conta-certa-introducao.md)
- [Tipos de conta suportados](https://docs.transfeera.dev/docs/conta-certa-tipos-de-conta-suportados.md)
- [Tipos de validação](https://docs.transfeera.dev/docs/conta-certa-tipos-de-validação.md)

## API Reference
- [Endpoints](https://docs.transfeera.dev/reference/endpoints.md): Abaixo estão listadas as URLs que serão utilizadas para acessar a nossa API e também a plataforma. No ambiente de produção e sandbox.
- [Run in Postman](https://docs.transfeera.dev/reference/run-in-postman.md): Criamos uma collection no Postman para que fique claro os endpoints e os possíveis erros que retornam na nossa API.
- [Token de autorização](https://docs.transfeera.dev/reference/post-authorization.md)
- [Habilitar mTLS em produção](https://docs.transfeera.dev/reference/habilitar-mtls-em-produção-mtls.md)
- [Consultar bancos](https://docs.transfeera.dev/reference/get_bank.md)
- [Criar lote](https://docs.transfeera.dev/reference/post_batch.md)
- [Consultar lotes](https://docs.transfeera.dev/reference/get_batch.md)
- [Processar o lote de pagamentos](https://docs.transfeera.dev/reference/post_batch-id-close.md)
- [Remover lote](https://docs.transfeera.dev/reference/delete_batch-id.md)
- [Consultar um lote](https://docs.transfeera.dev/reference/get_batch-id.md)
- [Editar lote](https://docs.transfeera.dev/reference/put_batch-id.md)
- [Consulta de chaves Pix](https://docs.transfeera.dev/reference/get_pix-dict-key-key.md)
- [Consultar Pix copia e cola (EMV)](https://docs.transfeera.dev/reference/post_pix-qrcode-parse.md)
- [Criar transferência](https://docs.transfeera.dev/reference/post_batch-id-transfer.md)
- [Consultar transferências dentro do lote](https://docs.transfeera.dev/reference/get_batch-id-transfer.md)
- [Consultar transferência](https://docs.transfeera.dev/reference/get_transfer-id.md)
- [Remover transferência](https://docs.transfeera.dev/reference/delete_batch-batchid-transfer-id.md)
- [Editar transferência](https://docs.transfeera.dev/reference/put_batch-batchid-transfer-id.md)
- [Consulta de boletos na CIP](https://docs.transfeera.dev/reference/get_billet-consult.md)
- [Criar boleto](https://docs.transfeera.dev/reference/post_batch-id-billet.md)
- [Editar boleto](https://docs.transfeera.dev/reference/put_batch-id-billet.md)
- [Consultar boletos dentro do lote](https://docs.transfeera.dev/reference/get_batch-id-billet.md)
- [Consultar boleto](https://docs.transfeera.dev/reference/get_billet-id.md)
- [Consultar boletos](https://docs.transfeera.dev/reference/get_billet.md)
- [Remover boleto](https://docs.transfeera.dev/reference/delete_batch-batchid-billet-id.md)
- [Consultar saldo](https://docs.transfeera.dev/reference/get_statement-balance.md)
- [Resgatar saldo](https://docs.transfeera.dev/reference/post_statement-withdraw.md)
- [Solicitar relatório de extrato](https://docs.transfeera.dev/reference/post_statement-report.md)
- [Consultar relatório de extrato por ID](https://docs.transfeera.dev/reference/get_statement-report-id.md)
- [Listar recorrências](https://docs.transfeera.dev/reference/get-payout_recurrences.md)
- [Listar pagamentos de uma recorrência](https://docs.transfeera.dev/reference/get-payout_recurrences-recurrence_id-payouts.md)
- [Cancelar recorrência](https://docs.transfeera.dev/reference/put-payout_recurrences-recurrence_id-cancel.md): A recorrência deve estar ativa para ser cancelada.  O cancelamento deve ser realizado até o dia anterior a data do próximo pagamento.
- [Eventos](https://docs.transfeera.dev/reference/pagamentos-eventos.md)
- [Erros](https://docs.transfeera.dev/reference/erros.md)
- [Como funciona](https://docs.transfeera.dev/reference/chaves-pix-como-funciona.md)
- [Criar chave](https://docs.transfeera.dev/reference/post_pix-key.md)
- [Consultar todas as chaves](https://docs.transfeera.dev/reference/get_pix-key.md)
- [Consultar chave por ID](https://docs.transfeera.dev/reference/get_pix-key-id.md)
- [Deletar uma chave](https://docs.transfeera.dev/reference/delete_pix-key-id.md)
- [Reenviar código de verificação](https://docs.transfeera.dev/reference/put_pix-key-id-resendverificationcode.md)
- [Verificar chave criada](https://docs.transfeera.dev/reference/put_pix-key-id-verify.md)
- [Reivindicar ou solicitar portabilidade de chave](https://docs.transfeera.dev/reference/post_pix-key-id-claim.md)
- [Confirmar reivindicação ou portabilidade](https://docs.transfeera.dev/reference/post_pix-key-id-claim-confirm.md)
- [Cancelar/negar reivindicação ou portabilidade](https://docs.transfeera.dev/reference/post_pix-key-id-claim-cancel.md)
- [Criar QR Code estático](https://docs.transfeera.dev/reference/post_pix-qrcode-static.md)
- [Criar cobrança imediata](https://docs.transfeera.dev/reference/post_pix-qrcode-collection-immediate.md)
- [Criar cobrança com vencimento](https://docs.transfeera.dev/reference/post_pix-qrcode-collection-duedate.md)
- [Listar QR Codes](https://docs.transfeera.dev/reference/get_pix-qrcode.md)
- [Buscar QR Code](https://docs.transfeera.dev/reference/get_pix-qrcode-id.md)
- [Revogar QR Code](https://docs.transfeera.dev/reference/delete_pix-qrcode-id.md)
- [Consultar Pix recebidos](https://docs.transfeera.dev/reference/get_pix-cashin.md)
- [Consultar Pix recebidos por end2endid](https://docs.transfeera.dev/reference/get_pix-cashin-end2endid.md)
- [Solicitar devolução de CashIn Pix recebido](https://docs.transfeera.dev/reference/post_pix-cashin-end2endid-refund.md)
- [Consultar devoluções de um cashin pix](https://docs.transfeera.dev/reference/get_pix-cashin-end2endid-refund.md)
- [Criar cobrança](https://docs.transfeera.dev/reference/post_charges.md)
- [Listar cobranças](https://docs.transfeera.dev/reference/get_charges.md)
- [Consultar cobrança](https://docs.transfeera.dev/reference/get_charges-id.md)
- [Cancelar cobrança](https://docs.transfeera.dev/reference/post_charges-id-cancel.md)
- [Download PDF](https://docs.transfeera.dev/reference/get_charges-charge-id-receivables-receivable-id-pdf.md)
- [Criar link de pagamento](https://docs.transfeera.dev/reference/post_payment-links.md)
- [Consultar links de pagamento](https://docs.transfeera.dev/reference/get_payment-links.md)
- [Excluir um link de pagamento](https://docs.transfeera.dev/reference/delete_payment-links-id.md)
- [Eventos](https://docs.transfeera.dev/reference/recebimentos-eventos.md)
- [Introdução](https://docs.transfeera.dev/reference/pix-automatico-introducao.md)
- [Requisitar nova autorização](https://docs.transfeera.dev/reference/create-automatic-pix-authorization.md)
- [Listar autorizações](https://docs.transfeera.dev/reference/list-automatic-pix-authorization.md)
- [Consultar autorização](https://docs.transfeera.dev/reference/get-automatic-pix-authorization.md)
- [Cancelar autorização](https://docs.transfeera.dev/reference/cancel-automatic-pix-authorization.md)
- [Consultar cancelamento de autorização](https://docs.transfeera.dev/reference/get-automatic-pix-authorization-cancellation.md)
- [Criar instrução de pagamento](https://docs.transfeera.dev/reference/create-automatic-pix-payment-intent.md)
- [Listar instruções de pagamento](https://docs.transfeera.dev/reference/list-automatic-pix-payment-intent.md)
- [Consultar instrução de pagamento](https://docs.transfeera.dev/reference/get-automatic-pix-payment-intent.md)
- [Cancelar instrução de pagamento](https://docs.transfeera.dev/reference/cancel-automatic-pix-payment-intent-cancellation.md)
- [Consultar cancelamento de instrução](https://docs.transfeera.dev/reference/get-automatic-pix-payment-intent-cancellation.md)
- [Atualizar autorização](https://docs.transfeera.dev/reference/update-automatic-pix-authorization.md): Permite atualizar o split_payment de uma autorização. O valor informado substitui completamente as informações existentes.
- [Enviar retentativa de instrução de pagamento](https://docs.transfeera.dev/reference/retry-automatic-pix-payment-intent.md)
- [Buscar bancos](https://docs.transfeera.dev/reference/get-banks.md)
- [Consultar validações](https://docs.transfeera.dev/reference/get-validation.md)
- [Criar validação](https://docs.transfeera.dev/reference/post-validation.md)
- [Consultar validação](https://docs.transfeera.dev/reference/get-validation-id.md)
- [Criar URL](https://docs.transfeera.dev/reference/post_webhook-2.md)
- [Consultar URLs](https://docs.transfeera.dev/reference/get_webhook-2.md)
- [Atualizar URLs](https://docs.transfeera.dev/reference/put_webhook-id-2.md)
- [Remover URL](https://docs.transfeera.dev/reference/delete_webhook-id-2.md)
- [Consultar eventos](https://docs.transfeera.dev/reference/get_webhook-event-2.md)
- [Reenviar eventos](https://docs.transfeera.dev/reference/post_webhook-event-retry-2.md)
- [Erros](https://docs.transfeera.dev/reference/contacerta-erros.md)
- [Eventos](https://docs.transfeera.dev/reference/eventos-1.md)
- [Criação de conta](https://docs.transfeera.dev/reference/post-account.md)
- [Listar contas](https://docs.transfeera.dev/reference/get-accounts.md)
- [Consultar conta](https://docs.transfeera.dev/reference/get-accounts-id.md)
- [Encerrar conta](https://docs.transfeera.dev/reference/post-accounts-id-close.md): Encerra a conta e remove chaves Pix relacionadas.
- [Erros](https://docs.transfeera.dev/reference/gerenciar-contas-erros.md)
- [Eventos](https://docs.transfeera.dev/reference/hub-de-contas-eventos.md)
- [Consultar infrações](https://docs.transfeera.dev/reference/get-infractions.md): Consulta infrações  > 📘  >  > Os campos `amount` e `refund_amount` da resposta **são números inteiros** que representam o valor em **centavos**, ou seja, um valor de R$150,35 será representado como `15035`.
- [Consultar infração](https://docs.transfeera.dev/reference/get-med-infractions-id.md): Obter uma infração pelo seu ID. > 📘  >  > Os campos `amount` e `refund_amount` da resposta **são números inteiros** que representam o valor em **centavos**, ou seja, um valor de R$150,35 será representado como `15035`.
- [Enviar análise de infrações em lote](https://docs.transfeera.dev/reference/post-med-infractions-analysis.md): Uma análise em lote para 1 ou mais infrações.  > 📘  >  > Os campos `amount` e `refund_amount` da resposta **são números inteiros** que representam o valor em **centavos**, ou seja, um valor de R$150,35 será representado como `15035`.
- [Enviar análise de infração](https://docs.transfeera.dev/reference/post-med-infractions-id-analysis.md): Envia uma análise para a infração especificada.  > 📘  >  > Os campos `amount` e `refund_amount` da resposta **são números inteiros** que representam o valor em **centavos**, ou seja, um valor de R$150,35 será representado como `15035`.
- [Eventos](https://docs.transfeera.dev/reference/eventos-2.md)
- [Criar URL](https://docs.transfeera.dev/reference/post_webhook.md)
- [Consultar URLs](https://docs.transfeera.dev/reference/get_webhook.md)
- [Atualizar URLs](https://docs.transfeera.dev/reference/put_webhook-id.md)
- [Remover URL](https://docs.transfeera.dev/reference/delete_webhook-id.md)
- [Consultar eventos](https://docs.transfeera.dev/reference/get_webhook-event.md)
- [Reenviar eventos](https://docs.transfeera.dev/reference/post_webhook-event-retry.md)
- [Verificação da assinatura](https://docs.transfeera.dev/reference/recebimentos-verificação-da-assinatura.md)