> For the complete documentation index, see [llms.txt](https://ajuda.pdvlegal.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.pdvlegal.com.br/integracoes/integracao-com-payby.md).

# Integração com PayBy

Ative a integração com a PayBy para o cliente pagar a conta da mesa pelo celular, lendo um QR Code, sem chamar o garçom.

A **PayBy** permite que o cliente do bar ou restaurante pague a própria conta pelo celular. Ele lê o QR Code da mesa, confere o consumo, paga o total ou divide a conta e vai embora, sem chamar o garçom.

A conta vem direto do **PDV Legal**. Quando a conta é quitada, o PDV Legal fecha a venda e emite a NFC-e automaticamente.

{% hint style="danger" %}
**Pré-requisitos**

* Loja usando o [Servidor Legal (Servidor em Nuvem)](https://ajuda.pdvlegal.com.br/operacoes-avancadas/servidor-legal-servidor-em-nuvem). A PayBy **não funciona** com servidor local nem com Raspberry.
* Módulos **PayBy** e **Servidor Legal** ativos na licença da filial, no **OEM**.
* Cadastro do cliente concluído com a PayBy.
* Para emitir nota fiscal, [Emissão de NFC-e pelo Gestão Legal (Cloud)](https://ajuda.pdvlegal.com.br/modulo-fiscal/emissao-de-nfc-e-pelo-gestao-legal-cloud) habilitada.
  {% endhint %}

{% hint style="info" %}
A PayBy não depende do [QR Code na Mesa](https://ajuda.pdvlegal.com.br/operacoes-avancadas/autoatendimento-mesa-tablet-na-mesa-qr-code-na-mesa-e-comanda-qr) do PDV Legal.
{% endhint %}

***

## O que é a PayBy

A **PayBy** é uma empresa parceira que desenvolveu uma solução de pagamento de contas em bares e restaurantes.

* **Não precisa instalar aplicativo.** O cliente lê o QR Code da mesa e a página da PayBy abre no navegador do celular.
* **Pagamento total ou dividido.** O cliente pode pagar a conta inteira, dividir em partes iguais ou escolher os itens que vai pagar.
* **Várias pessoas na mesma mesa.** Cada pessoa lê o QR Code no próprio celular e paga a sua parte.
* **Formas de pagamento:** PIX e cartão de crédito, inclusive com Google Pay e Apple Pay.

{% hint style="info" %}
Na integração com o PDV Legal, a PayBy é usada somente para o pagamento da conta. Os pedidos continuam sendo lançados no PDV, pelo garçom ou pelo autoatendimento (Qr\_Code na mesa ou Tablet na Mesa)
{% endhint %}

### Por que oferecer

* o garçom deixa de passar a maquininha em cada mesa e foca no atendimento
* a mesa é liberada mais rápido, principalmente no horário de pico
* o cliente confere a conta, que vem do PDV, e divide sem calculadora

O uso é opcional para o cliente final. Quem preferir pode continuar pagando com o garçom ou no caixa, como sempre.

***

## Como a PayBy se integra ao PDV Legal

{% stepper %}
{% step %}

### O cliente lê o QR Code da mesa

Cada mesa tem um QR Code fixo da PayBy, que identifica aquela mesa.
{% endstep %}

{% step %}

### A PayBy busca a conta no Servidor Legal

A PayBy consulta a conta aberta da mesa e exibe:

* itens consumidos, com adicionais e modificadores
* subtotal
* taxa de serviço, pela mesma regra do PDV
* desconto
* valor já pago
* valor a pagar
  {% endstep %}

{% step %}

### O cliente paga na PayBy

Depois da aprovação, a PayBy envia o pagamento para o PDV Legal.
{% endstep %}

{% step %}

### O PDV Legal registra o pagamento

* **Pagamento parcial:** o valor fica registrado como pago e o restante continua a receber. A mesa continua aberta.
* **Pagamento que quita a conta:** o PDV Legal fecha a conta, registra a venda com as formas de pagamento PayBy, emite a NFC-e pelo Cloud e libera a mesa.
  {% endstep %}
  {% endstepper %}

{% hint style="success" %}
O fechamento é automático. Não é preciso nenhuma ação do garçom ou do caixa.
{% endhint %}

{% hint style="info" %}

* Pagamentos parciais feitos no PDV também aparecem como já pagos na PayBy.
* Itens cancelados ou transferidos para outra mesa não aparecem na conta.
* A PayBy identifica a conta pelo número da **mesa** ou da **comanda**, exatamente como aparece no PDV.
  {% endhint %}

***

## 1. Liberação no OEM

> Libere a integração na licença da filial, como nas demais integrações.

{% stepper %}
{% step %}
Acesse o sistema **OEM**.
{% endstep %}

{% step %}
Pesquise o cliente pelo **Código**, **CNPJ** ou **Nome**.
{% endstep %}

{% step %}
Clique no ícone **Filiais** e localize a filial desejada.
{% endstep %}

{% step %}
Clique no ícone **Editar**.

Use o lápis para abrir a configuração da filial.
{% endstep %}

{% step %}
Role a tela para baixo, marque o módulo **PayBy** e clique em **Gravar**.

<figure><img src="https://1320237751-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLaIVEmahy7qwD0rmQzED%2Fuploads%2Flstrhv3jHanHxCGgJZuN%2Fimage.png?alt=media&amp;token=6a5cd24c-7515-47dc-8b93-0433dadcfcda" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Confirme se o módulo **Servidor Legal** também está ativo na filial.

Sem os dois módulos, a PayBy não consegue consultar a conta nem registrar o pagamento.
{% endstep %}
{% endstepper %}

***

## 2. Coloque a loja no Servidor Legal

Se o cliente ainda usa servidor local ou Raspberry, migre a operação para o **Servidor Legal** antes de começar a usar a PayBy.

Siga o passo a passo em [Servidor Legal (Servidor em Nuvem)](https://ajuda.pdvlegal.com.br/operacoes-avancadas/servidor-legal-servidor-em-nuvem), incluindo a etapa **Migrar de outro servidor**.

{% hint style="warning" %}
Antes de migrar, feche todas as contas abertas nos PDVs. Contas abertas no servidor anterior não são transferidas.
{% endhint %}

***

## 3. Cadastro do cliente na PayBy

O cadastro do estabelecimento é feito diretamente pela PayBy.

{% stepper %}
{% step %}

### Formulário de cadastro

A PayBy envia ao cliente um formulário de cadastro.

Nele, o cliente informa os dados da empresa e as contas bancárias para receber os pagamentos.
{% endstep %}

{% step %}

### Conexão com o PDV Legal

Com o módulo ativo, os dados de conexão da loja são informados à PayBy. A PayBy cadastra a loja do lado dela e passa a enxergar as contas do cliente no Servidor Legal.
{% endstep %}

{% step %}

### Implantação com o cliente

Depois que o cliente preenche o formulário, a implantação pode ser agendada.

* leva cerca de **1 hora**
* pode ser feita de forma remota
* agende um horário em que o cliente e os garçons possam participar
* explique o fluxo para a equipe e faça um pagamento de teste em uma mesa aberta
  {% endstep %}
  {% endstepper %}

{% hint style="info" %}
Depois da implantação, a PayBy atende o cliente em dúvidas e problemas de pagamento. Se necessário, ela verifica a comunicação com o PDV Legal.
{% endhint %}

***

## 4. Como o cliente paga a conta

{% stepper %}
{% step %}

### Escaneie o QR Code

O cliente lê o QR Code da mesa. A página do restaurante abre no navegador do celular, com as opções **Pagar Conta**, **Cardápio** e **Informações**.

O cliente toca em **Pagar Conta**.

<figure><img src="https://1320237751-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLaIVEmahy7qwD0rmQzED%2Fuploads%2FbPaUnjjbPz2oyJLFAZef%2Fpayby-01-escaneie-qr-code.png?alt=media&amp;token=954aea41-6e57-4c0e-8e45-186084913891" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Confira a conta

O cliente vê os itens consumidos, o subtotal, a taxa de serviço, o valor total e o valor a pagar.

Toque em **Continuar**.

<figure><img src="https://1320237751-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLaIVEmahy7qwD0rmQzED%2Fuploads%2FBqOgsc7JQC6iRCXLb0jx%2Fpayby-02-confira-a-conta.png?alt=media&amp;token=1a6fe91b-9e65-4621-91bb-2bdab9ceb54f" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Pague tudo ou divida

Escolha uma opção:

* **Pagar Total** — paga o valor a pagar da mesa
* **Dividir Conta** — divide em partes iguais ou seleciona os itens que vai pagar

Na seleção por item, o cliente usa os botões **+** e **−** em cada produto e toca em **Confirmar**. A taxa de serviço é calculada sobre o valor selecionado.

<figure><img src="https://1320237751-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLaIVEmahy7qwD0rmQzED%2Fuploads%2FVhTJVkIG7XaJAewv3gPq%2Fpayby-03-pague-total-ou-divida.png?alt=media&amp;token=8f5f6d97-de50-4a6f-b3de-4a0df090c1e9" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Escolha a forma de pagamento

O cliente escolhe **PIX** ou **Cartão de Crédito**, inclusive com Google Pay ou Apple Pay.

Confere o valor e toca em **Continuar**.

<figure><img src="https://1320237751-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLaIVEmahy7qwD0rmQzED%2Fuploads%2FhTtcbjF2pegW7ZNm9Qlf%2Fpayby-04-forma-de-pagamento.png?alt=media&amp;token=71c82ce8-b6f8-488b-b6ee-ccd47a336a61" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Avalie a experiência

Com o pagamento confirmado, a PayBy exibe **Pagamento realizado com sucesso!**. O cliente pode dar uma nota em estrelas e enviar o feedback.

O cliente também consegue consultar os pagamentos feitos e baixar o comprovante na página da PayBy.

<figure><img src="https://1320237751-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLaIVEmahy7qwD0rmQzED%2Fuploads%2F6MGZGGzblM4VtTjg0gd0%2Fpayby-05-avaliacao.png?alt=media&amp;token=244e3a61-d47c-4a78-80a4-d42dcbada531" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

***

## 5. Como o pagamento aparece no PDV Legal

* **Pagamento parcial:** o PDV mostra o valor como pago e o restante como a receber.
* **Conta quitada:** a mesa é fechada e sai da lista de mesas abertas. A venda aparece como paga no painel de vendas, com as formas de pagamento PayBy.
* **Nota fiscal:** emitida pelo PDV Legal, via Cloud, logo após a quitação.

{% hint style="warning" %}
**Pagamento por item**

Quando o cliente escolhe os itens na PayBy, o PDV Legal recebe apenas o **valor** pago, não quais itens foram pagos. No PDV, o valor entra como pagamento parcial da conta.

Se duas pessoas selecionarem o mesmo item ao mesmo tempo, as duas podem pagá-lo. O total pago nunca passa do valor da conta.
{% endhint %}

### Estorno

O estorno de um pagamento é feito no **painel da PayBy**, com senha de administrador.

***

***

### Manuais relacionados

* [Servidor Legal (Servidor em Nuvem)](https://ajuda.pdvlegal.com.br/operacoes-avancadas/servidor-legal-servidor-em-nuvem)
* [Emissão de NFC-e pelo Gestão Legal (Cloud)](https://ajuda.pdvlegal.com.br/modulo-fiscal/emissao-de-nfc-e-pelo-gestao-legal-cloud)
* [Autoatendimento Mesa (Tablet na Mesa, QR Code na Mesa e Comanda QR)](https://ajuda.pdvlegal.com.br/operacoes-avancadas/autoatendimento-mesa-tablet-na-mesa-qr-code-na-mesa-e-comanda-qr)
* [Auto Pagamento](https://ajuda.pdvlegal.com.br/pdv/modulos-de-operacao/auto-pagamento)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ajuda.pdvlegal.com.br/integracoes/integracao-com-payby.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
