Introdução

Bem-vindo à documentação da API de integração de sistema de pagamento da nossa plataforma de vendas. Esta API permite que outras plataformas, SaaS e terceiros integrem-se ao nosso sistema de pagamento de forma segura e eficiente. Nossa API segue os padrões REST e todas as respostas são enviadas no formato JSON.

Informações Essenciais

Códigos de Resposta HTTP

A API utiliza os seguintes códigos de resposta HTTP para indicar o status das requisições:

200 OK Requisição bem-sucedida.
201 Created Recurso criado com sucesso.
204 No Content Requisição bem-sucedida, mas sem conteúdo para retornar.
400 Bad Request Requisição inválida.
401 Unauthorized Autenticação necessária.
403 Forbidden Acesso negado.
404 Not Found ecurso não encontrado.
500 Internal Server Error Erro no servidor.

1. Transactions - Endpoints de Transações

[](data:image/svg+xml;utf8,%0A%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%2216%22%20height%3D%2216%22%20viewBox%3D%220%200%2016%2016%22%20fill%3D%22none%22%3E%0A%20%20%3Cpath%20d%3D%22M10.8%208.63V11.57C10.8%2014.02%209.82%2015%207.37%2015H4.43C1.98%2015%201%2014.02%201%2011.57V8.63C1%206.18%201.98%205.2%204.43%205.2H7.37C9.82%205.2%2010.8%206.18%2010.8%208.63Z%22%20stroke%3D%22%23717C92%22%20stroke-width%3D%221.05%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%2F%3E%0A%20%20%3Cpath%20d%3D%22M15%204.42999V7.36999C15%209.81999%2014.02%2010.8%2011.57%2010.8H10.8V8.62999C10.8%206.17999%209.81995%205.19999%207.36995%205.19999H5.19995V4.42999C5.19995%201.97999%206.17995%200.999992%208.62995%200.999992H11.57C14.02%200.999992%2015%201.97999%2015%204.42999Z%22%20stroke%3D%22%23717C92%22%20stroke-width%3D%221.05%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%2F%3E%0A%3C%2Fsvg%3E%0A)

2. Refund - Estorno de Pagamentos

3. Balance - Saldo

4. BalanceCashOut - Saldo por Provider

5. Webhooks

6. GetInstallments

7. CashOut