<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Webhooks on Documentação Orus</title><link>https://developers.orusprime.com.br/docs/webhook/</link><description>Recent content in Webhooks on Documentação Orus</description><generator>Hugo</generator><language>en-us</language><lastBuildDate>Sun, 12 Jul 2026 13:53:12 +0000</lastBuildDate><atom:link href="https://developers.orusprime.com.br/docs/webhook/index.xml" rel="self" type="application/rss+xml"/><item><title>1 - Webhooks</title><link>https://developers.orusprime.com.br/docs/webhook/webhook/</link><pubDate>Sun, 12 Jul 2026 13:53:12 +0000</pubDate><guid>https://developers.orusprime.com.br/docs/webhook/webhook/</guid><description>&lt;h2 id="10---tipos-de-webhooks-transacionais">1.0 - Tipos de webhooks transacionais&lt;/h2>
&lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Código&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>PIX_RECEBIDO&lt;/td>
 &lt;td>Recebimento de PIX&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>PIX_ENVIADO&lt;/td>
 &lt;td>Envio de PIX&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>COBRANCA_LIQUIDADA&lt;/td>
 &lt;td>Recebimento de cobrança PIX&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>RECEBIMENTO_P2P&lt;/td>
 &lt;td>Recebimento de P2P&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>ENVIO_P2P&lt;/td>
 &lt;td>Envio de P2P&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>ESTORNO&lt;/td>
 &lt;td>Estorno de PIX&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;p>Antes de realizar o disparo de cada um webhook, é necessário fornecer a url para que seja feita cadastrada internamente para os recebimentos.&lt;/p>
&lt;p>É possível receber notificações de webhook de acordo com:&lt;/p>
&lt;ul>
&lt;li>whitelabel&lt;/li>
&lt;li>owner&lt;/li>
&lt;/ul>
&lt;h2 id="11---webhook-de-recebimento-de-pix">1.1 - Webhook de Recebimento de PIX&lt;/h2>
&lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Tipo&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>id&lt;/td>
 &lt;td>Id do evento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>event_type&lt;/td>
 &lt;td>Tipo de envento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>operation_type&lt;/td>
 &lt;td>Tipo de Operação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>amount&lt;/td>
 &lt;td>Valor do recebimento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>description&lt;/td>
 &lt;td>Descrição&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>created_at&lt;/td>
 &lt;td>Data do disparo de webhook&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.name&lt;/td>
 &lt;td>Nome do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.document&lt;/td>
 &lt;td>Documento do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.id&lt;/td>
 &lt;td>Id do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.name&lt;/td>
 &lt;td>Nome do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.document&lt;/td>
 &lt;td>Documento do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>e2e&lt;/td>
 &lt;td>E2E da Operação&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-json" data-lang="json">&lt;span style="display:flex;">&lt;span> {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000000000000000000000000001&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;event_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;CREDIT&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;operation_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;pix&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;amount&amp;#34;&lt;/span>: &lt;span style="color:#ae81ff">0.01&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;description&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Recebimento de pix&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;created_at&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;2026-06-18 22:14:26&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;payer&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Nome do Pagador&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;***.***.***-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;receiver&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000-0000-0000-0000-000000000000&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;EMPRESA RECEBEDORA LTDA&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;**.***.***/****-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;e2e&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;E00000000000000000000000000000000000&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="12---webhook-de-liquidação-de-cobrança">1.2 - Webhook de liquidação de cobrança&lt;/h2>
&lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Tipo&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>id&lt;/td>
 &lt;td>Id do evento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>event_type&lt;/td>
 &lt;td>Tipo de envento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>operation_type&lt;/td>
 &lt;td>Tipo de Operação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>amount&lt;/td>
 &lt;td>Valor da liquidação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>description&lt;/td>
 &lt;td>Descrição&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>created_at&lt;/td>
 &lt;td>Data do disparo de webhook&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.name&lt;/td>
 &lt;td>Nome do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.document&lt;/td>
 &lt;td>Documento do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.id&lt;/td>
 &lt;td>Id do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.name&lt;/td>
 &lt;td>Nome do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.document&lt;/td>
 &lt;td>Documento do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>e2e&lt;/td>
 &lt;td>E2E da Operação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>charge_id&lt;/td>
 &lt;td>Id da pre transação&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-json" data-lang="json">&lt;span style="display:flex;">&lt;span> {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000000000000000000000000001&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;event_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;CREDIT&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;operation_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;pix&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;amount&amp;#34;&lt;/span>: &lt;span style="color:#ae81ff">0.01&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;description&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Recebimento de pix&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;created_at&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;2026-06-18 22:14:26&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;payer&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Nome do Pagador&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;***.***.***-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;receiver&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000-0000-0000-0000-000000000000&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;EMPRESA RECEBEDORA LTDA&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;**.***.***/****-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;e2e&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;E00000000000000000000000000000000000&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;charge_id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;10000000000000000000000000000001&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="13---webhook-de-estorno-de-pix">1.3 - Webhook de estorno de PIX&lt;/h2>
&lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Tipo&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>id&lt;/td>
 &lt;td>Id do evento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>event_type&lt;/td>
 &lt;td>Tipo de envento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>operation_type&lt;/td>
 &lt;td>Tipo de Operação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>amount&lt;/td>
 &lt;td>Valor da liquidação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>description&lt;/td>
 &lt;td>Descrição&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>created_at&lt;/td>
 &lt;td>Data do disparo de webhook&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.name&lt;/td>
 &lt;td>Nome do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.document&lt;/td>
 &lt;td>Documento do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.id&lt;/td>
 &lt;td>Id do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.name&lt;/td>
 &lt;td>Nome do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.document&lt;/td>
 &lt;td>Documento do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>origin_id&lt;/td>
 &lt;td>Id do envio do PIX (cash_in)&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-json" data-lang="json">&lt;span style="display:flex;">&lt;span> {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000000000000000000000000001&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;event_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;CREDIT&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;operation_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;estorno&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;amount&amp;#34;&lt;/span>: &lt;span style="color:#ae81ff">0.01&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;description&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Estorno de envio de pix&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;created_at&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;2026-06-18 22:14:26&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;payer&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Nome do Pagador&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;***.***.***-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;receiver&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000-0000-0000-0000-000000000000&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;EMPRESA RECEBEDORA LTDA&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;**.***.***/****-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;origin_id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;30000000000000000000000000000001&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="14---webhook-de-recebimento-de-p2p">1.4 - Webhook de Recebimento de P2P&lt;/h2>
&lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Tipo&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>id&lt;/td>
 &lt;td>Id do evento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>event_type&lt;/td>
 &lt;td>Tipo de envento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>operation_type&lt;/td>
 &lt;td>Tipo de Operação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>amount&lt;/td>
 &lt;td>Valor da liquidação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>description&lt;/td>
 &lt;td>Descrição&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>created_at&lt;/td>
 &lt;td>Data do disparo de webhook&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.name&lt;/td>
 &lt;td>Nome do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.document&lt;/td>
 &lt;td>Documento do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.id&lt;/td>
 &lt;td>Id do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.name&lt;/td>
 &lt;td>Nome do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.document&lt;/td>
 &lt;td>Documento do Recebedor&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-json" data-lang="json">&lt;span style="display:flex;">&lt;span> {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000000000000000000000000001&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;event_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;CREDIT&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;operation_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;p2p&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;amount&amp;#34;&lt;/span>: &lt;span style="color:#ae81ff">0.01&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;description&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Recebimento de p2p&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;created_at&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;2026-06-18 22:14:26&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;payer&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Nome do Pagador&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;***.***.***-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;receiver&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000-0000-0000-0000-000000000000&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;EMPRESA RECEBEDORA LTDA&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;**.***.***/****-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="15---webhook-de-envio-de-p2p">1.5 - Webhook de Envio de P2P&lt;/h2>
&lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Tipo&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>id&lt;/td>
 &lt;td>Id do evento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>event_type&lt;/td>
 &lt;td>Tipo de envento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>operation_type&lt;/td>
 &lt;td>Tipo de Operação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>amount&lt;/td>
 &lt;td>Valor da liquidação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>description&lt;/td>
 &lt;td>Descrição&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>created_at&lt;/td>
 &lt;td>Data do disparo de webhook&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.id&lt;/td>
 &lt;td>Id do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.name&lt;/td>
 &lt;td>Nome do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.document&lt;/td>
 &lt;td>Documento do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.name&lt;/td>
 &lt;td>Nome do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.document&lt;/td>
 &lt;td>Documento do Recebedor&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-json" data-lang="json">&lt;span style="display:flex;">&lt;span> {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000000000000000000000000001&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;event_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;DEBIT&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;operation_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;p2p&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;amount&amp;#34;&lt;/span>: &lt;span style="color:#ae81ff">0.01&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;description&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Envio de p2p&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;created_at&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;2026-06-18 22:14:26&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;payer&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000-0000-0000-0000-000000000000&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;EMPRESA RECEBEDORA LTDA&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;**.***.***/****-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;receiver&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Nome do Pagador&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;***.***.***-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h2 id="16---webhook-de-envio-de-pix">1.6 - Webhook de Envio de PIX&lt;/h2>
&lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Tipo&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>id&lt;/td>
 &lt;td>Id do evento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>event_type&lt;/td>
 &lt;td>Tipo de envento&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>operation_type&lt;/td>
 &lt;td>Tipo de Operação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>amount&lt;/td>
 &lt;td>Valor da liquidação&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>description&lt;/td>
 &lt;td>Descrição&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>created_at&lt;/td>
 &lt;td>Data do disparo de webhook&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.id&lt;/td>
 &lt;td>Id do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.name&lt;/td>
 &lt;td>Nome do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>payer.document&lt;/td>
 &lt;td>Documento do Pagador&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.name&lt;/td>
 &lt;td>Nome do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>receiver.document&lt;/td>
 &lt;td>Documento do Recebedor&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>e2e&lt;/td>
 &lt;td>E2E da Operação&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-json" data-lang="json">&lt;span style="display:flex;">&lt;span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000000000000000000000000001&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;event_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;DEBIT&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;operation_type&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;pix&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;amount&amp;#34;&lt;/span>: &lt;span style="color:#ae81ff">0.01&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;description&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Envio de pix&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;created_at&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;2026-06-18 22:14:26&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;payer&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;id&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;00000000-0000-0000-0000-000000000000&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;EMPRESA RECEBEDORA LTDA&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;**.***.***/****-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;receiver&amp;#34;&lt;/span>: {
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;name&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;Nome do Recebedor&amp;#34;&lt;/span>,
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;document&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;***.***.***-**&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> },
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> &lt;span style="color:#f92672">&amp;#34;e2e&amp;#34;&lt;/span>: &lt;span style="color:#e6db74">&amp;#34;E00000000000000000000000000000000000&amp;#34;&lt;/span>
&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span> }
&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;!--## 3.1 Cadastrar webhook

```
[POST] /webhook
```
Esse endpoint é responsável por cadastrar um webhook.
### [PAYLOAD]

| Propriedade | Descrição | Obrigatório | Condição | Tipo |
|-------------------|------------------------------------------------------|-------------|----------|---------------------------------|
| url | Url destinto; exemplo: https://webhook.domain.com.br | Sim | | String |
| bankAccount *gwc | Conta bancária alvo da notificação | Não | | String Mínimo: 5 - Máximo: 65 |


### [RESPONSES]

| Código | Descrição |
|--------|-----------------------|
| 201 | Webhook cadastrado |
| 403 | Webhook já cadastrado |










&lt;ul class="nav nav-tabs" id="tabs-0" role="tablist">
 &lt;li class="nav-item">
 &lt;button class="nav-link active"
 id="tabs-00-00-tab" data-bs-toggle="tab" data-bs-target="#tabs-00-00" role="tab"
 data-td-tp-persist="201" aria-controls="tabs-00-00" aria-selected="true">
 201
 &lt;/button>
 &lt;/li>&lt;li class="nav-item">
 &lt;button class="nav-link"
 id="tabs-00-01-tab" data-bs-toggle="tab" data-bs-target="#tabs-00-01" role="tab"
 data-td-tp-persist=" 403" aria-controls="tabs-00-01" aria-selected="false">
 403
 &lt;/button>
 &lt;/li>
&lt;/ul>

&lt;div class="tab-content" id="tabs-0-content">
 &lt;div class="tab-body tab-pane fade show active"
 id="tabs-00-00" role="tabpanel" aria-labelled-by="tabs-00-00-tab" tabindex="0">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da inserção.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a inserção.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data._id&lt;/td>
 &lt;td>Id do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:true,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook cadastrado com sucesso&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;_id&amp;#34;:&amp;#34;1b7dc891ac7ad7&amp;#34;
 }
 
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
 &lt;div class="tab-body tab-pane fade"
 id="tabs-00-01" role="tabpanel" aria-labelled-by="tabs-00-01-tab" tabindex="0">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da inserção.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a inserção.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.errCode&lt;/td>
 &lt;td>Código do erro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:false,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook com mesmas informações já cadastrado&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;errCode&amp;#34;:&amp;#34;G406&amp;#34;
 }
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
&lt;/div>




## 3.2 Editar webhook

```
[PATCH] /webhook/{id}
```
Esse endpoint é responsável por editar um webhook.
### [PAYLOAD]

| Propriedade | Descrição | Obrigatório | Condição | Tipo |
|-------------------|------------------------------------------------------|-------------|----------|---------------------------------|
| id (pathParam) | Id do webhook alvo de alteração | Sim | | String |
| url | Url destinto; exemplo: https://webhook.domain.com.br | Sim | | String |
| bankAccount *gwc | Conta bancária alvo da notificação | Não | | String Mínimo: 5 - Máximo: 65 |



### [RESPONSES]

| Código | Descrição |
|--------|-----------------------|
| 200 | Webhook atualizado |
| 403 | Webhook já cadastrado |










&lt;ul class="nav nav-tabs" id="tabs-1" role="tablist">
 &lt;li class="nav-item">
 &lt;button class="nav-link active"
 id="tabs-01-00-tab" data-bs-toggle="tab" data-bs-target="#tabs-01-00" role="tab"
 data-td-tp-persist="201" aria-controls="tabs-01-00" aria-selected="true">
 201
 &lt;/button>
 &lt;/li>&lt;li class="nav-item">
 &lt;button class="nav-link"
 id="tabs-01-01-tab" data-bs-toggle="tab" data-bs-target="#tabs-01-01" role="tab"
 data-td-tp-persist=" 403" aria-controls="tabs-01-01" aria-selected="false">
 403
 &lt;/button>
 &lt;/li>
&lt;/ul>

&lt;div class="tab-content" id="tabs-1-content">
 &lt;div class="tab-body tab-pane fade show active"
 id="tabs-01-00" role="tabpanel" aria-labelled-by="tabs-01-00-tab" tabindex="1">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da atualização.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a atualização.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data._id&lt;/td>
 &lt;td>Id do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:true,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook atualizado com sucesso&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;_id&amp;#34;:&amp;#34;1b7dc891ac7ad7&amp;#34;
 }
 
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
 &lt;div class="tab-body tab-pane fade"
 id="tabs-01-01" role="tabpanel" aria-labelled-by="tabs-01-01-tab" tabindex="1">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da atualização.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a atualização.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.errCode&lt;/td>
 &lt;td>Código do erro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:false,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook com mesmas informações já cadastrado&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;errCode&amp;#34;:&amp;#34;G406&amp;#34;
 }
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
&lt;/div>







## 3.3 Consultar webhook

```
[GET] /webhook/{id}?ispb={ispb}
```
Esse endpoint é responsável por consultar um webhook
### [PAYLOAD]

| Propriedade | Descrição | Obrigatório | Condição | Tipo |
|-------------------|---------------|-------------|----------|---------------------------------|
| id (pathParam) | Id do webhook | Sim | | String |



### [RESPONSES]

| Código | Descrição |
|--------|-----------------------|
| 200 | Webhook consultado |
| 404 | Webhook não encontrado |










&lt;ul class="nav nav-tabs" id="tabs-2" role="tablist">
 &lt;li class="nav-item">
 &lt;button class="nav-link active"
 id="tabs-02-00-tab" data-bs-toggle="tab" data-bs-target="#tabs-02-00" role="tab"
 data-td-tp-persist="200" aria-controls="tabs-02-00" aria-selected="true">
 200
 &lt;/button>
 &lt;/li>&lt;li class="nav-item">
 &lt;button class="nav-link"
 id="tabs-02-01-tab" data-bs-toggle="tab" data-bs-target="#tabs-02-01" role="tab"
 data-td-tp-persist=" 404" aria-controls="tabs-02-01" aria-selected="false">
 404
 &lt;/button>
 &lt;/li>
&lt;/ul>

&lt;div class="tab-content" id="tabs-2-content">
 &lt;div class="tab-body tab-pane fade show active"
 id="tabs-02-00" role="tabpanel" aria-labelled-by="tabs-02-00-tab" tabindex="2">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data._id&lt;/td>
 &lt;td>Id do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.bankAccount&lt;/td>
 &lt;td>Conta bancária alvo da notificação&lt;/td>
 &lt;td>Não&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.ispb&lt;/td>
 &lt;td>Id ispb alvo da notificação&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.url&lt;/td>
 &lt;td>Url que será enviada a notificação&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.created_at&lt;/td>
 &lt;td>Data de criação do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.updated_at&lt;/td>
 &lt;td>Data de atualização do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:true,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook consulta com sucesso&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;_id&amp;#34;:&amp;#34;1b7dc891ac7ad7&amp;#34;,
 &amp;#34;bankAccount&amp;#34;:&amp;#34;&amp;#34;,
 &amp;#34;ispb&amp;#34;:&amp;#34;669854&amp;#34;,
 &amp;#34;url&amp;#34;:&amp;#34;https://abc.com.br&amp;#34;,
 &amp;#34;created_at&amp;#34;:&amp;#34;2023-08-22T10:30:10.008Z&amp;#34;,
 &amp;#34;updated_at&amp;#34;:&amp;#34;2023-08-22T10:30:10.008Z&amp;#34;
 }
 
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
 &lt;div class="tab-body tab-pane fade"
 id="tabs-02-01" role="tabpanel" aria-labelled-by="tabs-02-01-tab" tabindex="2">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.errCode&lt;/td>
 &lt;td>Código do erro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:false,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook não encontrado&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;errCode&amp;#34;:&amp;#34;G404&amp;#34;
 }
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
&lt;/div>




## 3.4 Deletar Webhook

```
[DELETE] /webhook/{id}
```
### [PAYLOAD]
Esse endpoint é responsável por deletar um webhook.


| Propriedade | Descrição | Obrigatório | Condição | Tipo |
|-------------------|---------------|-------------|----------|---------------------------------|
| id (pathParam) | Id do webhook | Sim | | String |




### [RESPONSES]

| Código | Descrição |
|--------|-----------------------|
| 200 | Webhook consultado |
| 404 | Webhook não encontrado |










&lt;ul class="nav nav-tabs" id="tabs-3" role="tablist">
 &lt;li class="nav-item">
 &lt;button class="nav-link active"
 id="tabs-03-00-tab" data-bs-toggle="tab" data-bs-target="#tabs-03-00" role="tab"
 data-td-tp-persist="201" aria-controls="tabs-03-00" aria-selected="true">
 201
 &lt;/button>
 &lt;/li>&lt;li class="nav-item">
 &lt;button class="nav-link"
 id="tabs-03-01-tab" data-bs-toggle="tab" data-bs-target="#tabs-03-01" role="tab"
 data-td-tp-persist=" 404" aria-controls="tabs-03-01" aria-selected="false">
 404
 &lt;/button>
 &lt;/li>
&lt;/ul>

&lt;div class="tab-content" id="tabs-3-content">
 &lt;div class="tab-body tab-pane fade show active"
 id="tabs-03-00" role="tabpanel" aria-labelled-by="tabs-03-00-tab" tabindex="3">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:true,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook deletado com sucesso&amp;#34;
 
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
 &lt;div class="tab-body tab-pane fade"
 id="tabs-03-01" role="tabpanel" aria-labelled-by="tabs-03-01-tab" tabindex="3">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.errCode&lt;/td>
 &lt;td>Código do erro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:false,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook não encontrado&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;errCode&amp;#34;:&amp;#34;G404&amp;#34;
 }
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
&lt;/div>









## 3.5 Listar webhooks

```
[GET] /webhook/?ispb={ispb}&amp;bankAcount={bankAccount}
```
Esse endpoint é responsável por listar webhooks.

### [PAYLOAD]
| Propriedade | Descrição | Obrigatório | Condição | Tipo |
|-------------------|------------------------------------|-------------|----------|---------------------------------|
| bankAccount *gwc | Conta bancária alvo da notificação | Não | | String Mínimo: 5 - Máximo: 65 |



### [RESPONSES]

| Código | Descrição |
|--------|-----------------------|
| 200 | Webhooks listados |
| 404 | Webhook não encontrado |











&lt;ul class="nav nav-tabs" id="tabs-4" role="tablist">
 &lt;li class="nav-item">
 &lt;button class="nav-link active"
 id="tabs-04-00-tab" data-bs-toggle="tab" data-bs-target="#tabs-04-00" role="tab"
 data-td-tp-persist="200" aria-controls="tabs-04-00" aria-selected="true">
 200
 &lt;/button>
 &lt;/li>&lt;li class="nav-item">
 &lt;button class="nav-link"
 id="tabs-04-01-tab" data-bs-toggle="tab" data-bs-target="#tabs-04-01" role="tab"
 data-td-tp-persist=" 404" aria-controls="tabs-04-01" aria-selected="false">
 404
 &lt;/button>
 &lt;/li>&lt;li class="nav-item">
 &lt;button class="nav-link"
 id="tabs-04-02-tab" data-bs-toggle="tab" data-bs-target="#tabs-04-02" role="tab"
 aria-controls="tabs-04-02" aria-selected="false">
 404
 &lt;/button>
 &lt;/li>
&lt;/ul>

&lt;div class="tab-content" id="tabs-4-content">
 &lt;div class="tab-body tab-pane fade show active"
 id="tabs-04-00" role="tabpanel" aria-labelled-by="tabs-04-00-tab" tabindex="4">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa de mapa com informações de listagem.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data[]._id&lt;/td>
 &lt;td>Id do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data[].bankAccount&lt;/td>
 &lt;td>Conta bancária alvo da notificação&lt;/td>
 &lt;td>Não&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data[].ispb&lt;/td>
 &lt;td>Id ispb alvo da notificação&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data[].url&lt;/td>
 &lt;td>Url que será enviada a notificação&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data[].created_at&lt;/td>
 &lt;td>Data de criação do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data[].updated_at&lt;/td>
 &lt;td>Data de atualização do registro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:true,
 &amp;#34;message&amp;#34;: &amp;#34;Webhook consulta com sucesso&amp;#34;,
 &amp;#34;data&amp;#34;:[
 {
 &amp;#34;_id&amp;#34;:&amp;#34;2b7dc891ac7ad8&amp;#34;,
 &amp;#34;ispb&amp;#34;:&amp;#34;669854&amp;#34;,
 &amp;#34;bankAccount&amp;#34;:&amp;#34;1235&amp;#34;,
 &amp;#34;url&amp;#34;:&amp;#34;https://abc.com.br&amp;#34;,
 &amp;#34;created_at&amp;#34;:&amp;#34;2023-08-22T10:30:10.008Z&amp;#34;,
 &amp;#34;updated_at&amp;#34;:&amp;#34;2023-08-22T10:30:10.008Z&amp;#34;
 },
 {
 &amp;#34;_id&amp;#34;:&amp;#34;1b7dc891ac7ad7&amp;#34;,
 &amp;#34;ispb&amp;#34;:&amp;#34;669854&amp;#34;,
 &amp;#34;bankAccount&amp;#34;:&amp;#34;123&amp;#34;,
 &amp;#34;url&amp;#34;:&amp;#34;https://abc.com.br&amp;#34;,
 &amp;#34;created_at&amp;#34;:&amp;#34;2023-08-22T10:30:10.008Z&amp;#34;,
 &amp;#34;updated_at&amp;#34;:&amp;#34;2023-08-22T10:30:10.008Z&amp;#34;
 }

]
 
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
 &lt;div class="tab-body tab-pane fade"
 id="tabs-04-01" role="tabpanel" aria-labelled-by="tabs-04-01-tab" tabindex="4">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.errCode&lt;/td>
 &lt;td>Código do erro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:false,
 &amp;#34;message&amp;#34;: &amp;#34;Webhooks não encontrados&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;errCode&amp;#34;:&amp;#34;G404&amp;#34;
 }
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
 &lt;div class="tab-body tab-pane fade"
 id="tabs-04-02" role="tabpanel" aria-labelled-by="tabs-04-02-tab" tabindex="4">
 &lt;table>
 &lt;thead>
 &lt;tr>
 &lt;th>Propriedade&lt;/th>
 &lt;th>Descrição&lt;/th>
 &lt;th>Obrigatório&lt;/th>
 &lt;th>Tipo&lt;/th>
 &lt;/tr>
 &lt;/thead>
 &lt;tbody>
 &lt;tr>
 &lt;td>success&lt;/td>
 &lt;td>Booleano que identifica o sucesso ou não da consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Boolean&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>message&lt;/td>
 &lt;td>Mensagem de retorno sobre a consulta.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data&lt;/td>
 &lt;td>Mapa com informações do webhook.&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>Mapa&lt;/td>
 &lt;/tr>
 &lt;tr>
 &lt;td>data.errCode&lt;/td>
 &lt;td>Código do erro&lt;/td>
 &lt;td>Sim&lt;/td>
 &lt;td>String&lt;/td>
 &lt;/tr>
 &lt;/tbody>
&lt;/table>
&lt;pre tabindex="0">&lt;code>
{
 &amp;#34;success&amp;#34;:false,
 &amp;#34;message&amp;#34;: &amp;#34;Webhooks não encontrados&amp;#34;,
 &amp;#34;data&amp;#34;:{
 &amp;#34;errCode&amp;#34;:&amp;#34;G404&amp;#34;
 }
 
}
&lt;/code>&lt;/pre>
 &lt;/div>
&lt;/div>
 --></description></item></channel></rss>