PUSHINPAY

Criar PIX

Consultar PIX

Default

Bem vindo a API da PushinPay, aqui vocẽ entrará a documentação completa de Pix cashin e Pix cashout

API PIX PUSHINpay

Production

Produção

SandBox (Homolog)

SandBox

<p class="slate-p " ><span style="background-color:rgb(243, 247, 249);color:rgb(51, 51, 51)">Esse endpoint cria um código PIX para pagamento.</span></p><p class="slate-p " ><span style="background-color:rgb(243, 247, 249);color:rgb(51, 51, 51)">Pontos de atenção</span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Tenha sua conta CRIADA e Aprovada.</div></li><li class="slate-li " ><div style="position:relative">Caso não tenha conta realizar no link <a href="https://app.pushinpay.com.br/register" target="_self">https://app.pushinpay.com.br/register</a></div></li><li class="slate-li " ><div style="position:relative">Para utilização do ambiente SANDBOX fazer o cadastro primeiramente no ambiente de produção (acima) e depois no suporte solicitar a liberação do ambiente SANDBOX;</div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(243, 247, 249);color:rgb(51, 51, 51)">Valores sempre em CENTAVOS.</span></div></li><li class="slate-li " ><div style="position:relative">Valor mínimo de 50 centavos;</div></li><li class="slate-li " ><div style="position:relative">Checar o limite de valor máximo em sua conta;</div></li><li class="slate-li " ><div style="position:relative">Caso não tenha um servidor para receber as notificações da transação não preencha o campo webhook_url;</div></li></ul><p class="slate-p " ></p><p class="slate-p " >Obrigatoriedade de Aviso sobre o Papel da PUSHIN PAY</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Item <a href="4.10" target="_self">4.10</a> do nosso Termos de Uso <a href="https://pushinpay.com.br/termos-de-uso" target="_self">https://pushinpay.com.br/termos-de-uso</a>;</div></li><li class="slate-li " ><div style="position:relative">É de responsabilidade do usuário da plataforma PUSHIN PAY, titular da conta, <strong class="slate-bold">informar de maneira clara, destacada e acessível</strong> em seus canais de venda (sites, redes sociais, aplicativos, plataformas, entre outros), que:</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">“A PUSHIN PAY atua exclusivamente como processadora de pagamentos e não possui qualquer responsabilidade pela entrega, suporte, conteúdo, qualidade ou cumprimento das obrigações relacionadas aos produtos ou serviços oferecidos pelo vendedor.”</strong></div></li><li class="slate-li " ><div style="position:relative">Esse aviso deve constar <strong class="slate-bold">no momento da oferta e antes da finalização do pagamento</strong>, preferencialmente na página de checkout, nos termos de compra e/ou nas comunicações automáticas relacionadas à transação.</div></li><li class="slate-li " ><div style="position:relative">O não cumprimento pode gerar penalizações e até bloqueio da conta;</div></li></ul><p class="slate-p " ></p><h4 class="slate-h4 " >Exemplo de Resposta - Endpoint </h4><p class="slate-p " >{
  &quot;id&quot;: &quot;9c29870c-9f69-4bb6-90d3-2dce9453bb45&quot;,
  &quot;qr_code&quot;: &quot;00020101021226770014BR.GOV.BCB.PIX2555api...&quot;,
  &quot;status&quot;: &quot;created&quot;,
  &quot;value&quot;: 35,
  &quot;webhook_url&quot;: &quot;http://teste.com&quot;,
  &quot;qr_code_base64&quot;: &quot;data:image/png;base64,iVBORw0KGgoAA.....&quot;,
  &quot;webhook&quot;: null,
  &quot;split_rules&quot;: [],
  &quot;end_to_end_id&quot;: null,
  &quot;payer_name&quot;: null,
  &quot;payer_national_registration&quot;: null
}</p><p class="slate-p " >

📝 Descrição dos Campos</p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-div"><p class="slate-p " >Campo</p></div><div class="slate-div"><p class="slate-p " >Tipo</p></div><div class="slate-div"><p class="slate-p " >Descrição</p></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">id</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Identificador único da transação gerada. Salve a mesma para consultar o status da mesma.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">qr_code</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Código PIX completo no padrão EMV para ser copiado e pago manualmente.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">status</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Status atual da transação (<code class="slate-code">created</code>, <code class="slate-code">paid ou expired</code>.).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">value</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integer</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Valor da cobrança em centavos de reais.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">webhook_url</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >URL informada para receber notificações de pagamento.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">qr_code_base64</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Imagem do QR Code no formato base64, ideal para exibição.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">webhook</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string/null</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Retorno interno do processamento da notificação enviada, se houver.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">split_rules</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >array</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Lista com as regras de divisão de valores (caso existam splits configurados). </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">end_to_end_id</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string/null</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Código identificador do PIX gerado pelo Banco Central (aparece após o pagamento).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">payer_name</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string/null</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Nome do pagador, retornado após o pagamento.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">payer_national_registration</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string/null</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >CPF ou CNPJ do pagador, retornado após o pagamento.</p><p class="slate-p " ></p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p><h3 class="slate-h3 " >Webhook de retorno</h3><p class="slate-p " >Ao adicionar o campo webhook_url na criação do qrcode pix, quando o status for alterados e caso falhe a tentativa nós tentaremos enviar 3x, e caso as 3x falhe, via painel administrativo será possível retomar os envios do mesmo. Também é possível adicionar um header customizado que iremos enviar para você em todos os webhooks, essa configuração está disponível em seu menu de configurações de nosso painel</p><p class="slate-p " ><span style="background-color:rgb(201, 122, 126);color:rgb(51, 51, 51)">Não recomendamos a pratica de scrap, por isso atente-se a usar os nossos webhooks para receber alterações de status</span></p><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Erros de Limite e Validação</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Valor acima do limite permitido:</strong> Quando o valor enviado para geração do QR Code PIX ultrapassa o limite máximo configurado na conta , será retornada a mensagem informando o valor máximo permitido ;</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Valor do split maior que o valor total:</strong> Se o valor definido para o split for maior do que o valor total da transação, será retornado um erro indicando que o valor da transação não pode ser menor que o valor do split.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Split + taxa maior que o valor total:</strong> Quando a soma do valor do split com a taxa de transação for maior que o valor total da transação, o sistema retorna uma mensagem indicando que isso não é permitido.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Conta de split não encontrada:</strong> Caso o <span style="background-color:rgba(9, 30, 66, 0.06);color:rgb(23, 43, 77)"><code class="slate-code">account_id</code></span> informado em algum dos splits não corresponda a uma conta válida no banco de dados, será exibida uma mensagem de erro informando que a conta não foi encontrada.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Valor total dos splits excede o valor da transação:</strong> Se a soma dos valores dos splits (incluindo a taxa) for maior que o valor total da transação, um erro será retornado informando que a soma não pode exceder o valor da transação.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Splits do token inválidos:</strong> A mesma validação anterior se aplica ao caso em que os splits vêm de um token usado na geração da transação. Se os valores forem inconsistentes, o erro indicará que a soma dos splits vinculados ao token não pode exceder o valor da transação.</div></li></ul><p class="slate-p " ></p>

Esse endpoint cria um código PIX para pagamento.

Obrigatoriedade de Aviso sobre o Papel da PUSHIN PAY

Title

Description

Ao adicionar o campo webhook_url na criação do qrcode pix, quando o status for alterados e caso falhe a tentativa nós tentaremos enviar 3x, e caso as 3x falhe, via painel administrativo será possível retomar os envios do mesmo. Também é possível adicionar um header customizado que iremos enviar para você em todos os webhooks, essa configuração está disponível em seu menu de configurações de nosso painel

Não recomendamos a pratica de scrap, por isso atente-se a usar os nossos webhooks para receber alterações de status

Adicione o valor em centavos. O mínimo deve ser 50 centavos

value

Caso tenha um servidor para receber as informações de pagamento ou estorno informe aqui sua URL

webhook_url

Utilizado para realizar SPLIT para várias contas já cadastradas na PUSHINPAY
{
            "value": 50,
            "account_id": "9C3XXXXX3A043"
        }

split_rules

Authorization

Accept

Content-Type

Bad Request -- Composição do request inválido

Method Not Allowed -- Método não permitido

Gone -- Essa requisição não existe mais

Too Many Requests -- Muitas requisições em um curto espaço de tempo

Internal Server Error -- Favor tente mais tarde

Service Unavailable -- Estamos temporariamente inativos, favor aguardar.

<p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(243, 247, 249);color:rgb(51, 51, 51)">Esse endpoint para consultar o STATUS de uma transação PIX.</span></p><p class="slate-p " ><span style="background-color:rgb(243, 247, 249);color:rgb(51, 51, 51)">Pontos de atenção</span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(243, 247, 249);color:rgb(51, 51, 51)">Recomendamos que seja feita apenas a consulta quando o cliente FINAL identifique por alguma ação que foi pago. </span></div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:rgb(243, 247, 249);color:rgb(51, 51, 51)">Consultas diretas são autorizadas a cada 1 minuto. Caso seja feito requisições abaixo desse tempo sua conta poderá ser bloqueada;</span></div></li></ul><p class="slate-p " ></p><p class="slate-p " >O retorno do ENDPOINT é igual ao de criar PIX, favor verificar.</p><p class="slate-p " ></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(23, 43, 77)">Consultar PIX: esta faltado o Response  200 para ok e 404 se nao encontrado e retornado um null</span></p><p class="slate-p " ></p>

Esse endpoint para consultar o STATUS de uma transação PIX.

O retorno do ENDPOINT é igual ao de criar PIX, favor verificar.

Consultar PIX: esta faltado o Response  200 para ok e 404 se nao encontrado e retornado um null

Sections