> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Uso e configuração

> Adicione o nó do Payphone ao seu fluxo no Canvas e configure seus inputs e outputs.

Após conectar a integração no Marketplace com o **Access Token**, o **Store ID**, o **IVA** e a **Moeda**, o nó do **Payphone** fica disponível no seu workspace para usar dentro dos seus fluxos no Canvas.

***

## Adicionar o nó ao Canvas

<Steps>
  <Step title="Localizar a integração no Marketplace">
    No painel lateral esquerdo do Brain Studio, abra a pasta **Marketplace**.

    Se a integração estiver corretamente conectada, você verá o **Payphone** listado como provedor disponível.

    <Frame caption="Payphone disponível no painel lateral do Marketplace">
      <img src="https://mintcdn.com/jelouai/N-faBULcr0WC2nPA/assets/images/integraciones/pagos/payphone-ambiente.png?fit=max&auto=format&n=N-faBULcr0WC2nPA&q=85&s=c3f184139f5b5ea2ed12341f9ad6d497" alt="Payphone visível na pasta Marketplace dentro do painel lateral do Brain Studio" width="944" height="480" data-path="assets/images/integraciones/pagos/payphone-ambiente.png" />
    </Frame>
  </Step>

  <Step title="Arrastar o nó para o Canvas">
    Arraste o **Payphone** do painel lateral para o seu fluxo no Canvas.

    Ao soltá-lo, o bloco do nó será criado com seus outputs disponíveis.
  </Step>

  <Step title="Abrir o painel de configuração">
    Selecione o nó no Canvas para abrir o seu painel de configuração no lado direito.

    A partir daí você poderá preencher os **inputs** e revisar os **outputs** disponíveis.

    <Frame caption="Painel completo de configuração do nó do Payphone no Brain Studio">
      <img src="https://mintcdn.com/jelouai/N-faBULcr0WC2nPA/assets/images/integraciones/pagos/payphone-configuracion-completa.png?fit=max&auto=format&n=N-faBULcr0WC2nPA&q=85&s=6e5fe489bc12b8f84ca3daa0beeb7cd4" alt="Painel lateral de configuração do nó do Payphone exibindo todos os campos disponíveis" width="970" height="1024" data-path="assets/images/integraciones/pagos/payphone-configuracion-completa.png" />
    </Frame>
  </Step>
</Steps>

***

## Configurar o nó

<Tabs>
  <Tab title="Inputs">
    <AccordionGroup>
      <Accordion title="Salvar resultado como" icon="database">
        <ParamField body="Salvar resultado como" type="string">
          Define o nome da variável onde o Brain Studio armazenará o **JSON completo** de resposta do nó.

          <Tip>
            Útil se você quiser usar a resposta posteriormente (logs, validações, rastreabilidade ou decisões do fluxo).
          </Tip>
        </ParamField>
      </Accordion>

      <Accordion title="Modalidade de cobrança [pagamento único por padrão]" icon="credit-card">
        <ParamField body="Modalidade de cobrança [pagamento único por padrão]" type="string" default="payment">
          Define a modalidade de cobrança.

          Para esta integração, o valor padrão é `payment`.
        </ParamField>
      </Accordion>

      <Accordion title="Ambiente" icon="server">
        <ParamField body="Ambiente" type="string" required>
          Define o ambiente no qual a cobrança será executada.

          **Valores disponíveis:** `DEV`, `PROD`
        </ParamField>

        <Warning>
          O valor configurado aqui deve corresponder ao ambiente selecionado na aplicação dentro do **Payphone Developer**.

          Se você configurar `DEV` no nó, mas a aplicação estiver em produção, ou vice-versa, o fluxo pode falhar ou gerar resultados inconsistentes.
        </Warning>
      </Accordion>

      <Accordion title="Expiração do botão de pagamento [minutos]" icon="clock">
        <ParamField body="Expiração do botão de pagamento [minutos]" type="number">
          Define por quanto tempo o botão de pagamento permanece válido a partir do momento em que é enviado ao usuário.

          **Valores disponíveis:** `10`, `20`, `30`, `60`
        </ParamField>
      </Accordion>

      <Accordion title="Motivo do pagamento" icon="file-lines">
        <ParamField body="Motivo do pagamento" type="string" required>
          Texto descritivo da cobrança.

          Exemplos:

          * número do pedido
          * nome do produto ou serviço
          * referência interna do pagamento
        </ParamField>
      </Accordion>

      <Accordion title="Valor sujeito a impostos" icon="receipt">
        <ParamField body="Valor sujeito a impostos" type="number" required>
          Informe o valor a cobrar que está sujeito a impostos.

          Aceita valores numéricos em dólares, incluindo decimais quando aplicável.
        </ParamField>
      </Accordion>

      <Accordion title="Valor isento de impostos" icon="dollar-sign">
        <ParamField body="Valor isento de impostos" type="number" required>
          Informe o valor a cobrar que está isento de impostos.

          Aceita valores numéricos em dólares, incluindo decimais quando aplicável.
        </ParamField>
      </Accordion>

      <Accordion title="Metadados do pagamento" icon="tag">
        <ParamField body="Metadados do pagamento" type="string">
          Informações adicionais para rastreabilidade ou referência interna.

          <Info>
            Você pode usar este campo para correlacionar o pagamento com um pedido, uma cotação ou uma operação de conciliação.
          </Info>
        </ParamField>
      </Accordion>

      <Accordion title="Personalizar textos do botão de pagamento" icon="message">
        <ParamField body="Personalizar textos do botão de pagamento" type="boolean" default="false">
          Se você selecionar **Sim**, campos adicionais são habilitados para personalizar a mensagem que acompanha o botão de pagamento.

          **Campos habilitados ao ativar:**

          * `Header` (obrigatório)
          * `Body` (obrigatório)
          * `Footer` (obrigatório)
        </ParamField>

        <Info>
          Quando esta opção está ativa, você pode modificar completamente a mensagem que o usuário verá antes de abrir o checkout.
        </Info>
      </Accordion>

      <Accordion title="Header" icon="heading">
        <ParamField body="Header" type="string">
          Título da mensagem que acompanha o botão de pagamento.
        </ParamField>
      </Accordion>

      <Accordion title="Body" icon="align-left">
        <ParamField body="Body" type="string">
          Texto principal da mensagem que acompanha o botão de pagamento.
        </ParamField>
      </Accordion>

      <Accordion title="Footer" icon="minus">
        <ParamField body="Footer" type="string">
          Texto de encerramento ou aviso da mensagem que acompanha o botão de pagamento.
        </ParamField>
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Outputs">
    <AccordionGroup>
      <Accordion title="Pagamento bem-sucedido" icon="circle-check">
        Acionado quando o Payphone confirma que a transação foi processada corretamente.

        Este é o ponto oficial de confirmação do pagamento dentro do fluxo.

        Exemplos de uso:

        * emitir nota fiscal
        * ativar uma assinatura
        * liberar um produto ou serviço
        * atualizar o status de um pedido em um sistema externo
      </Accordion>

      <Accordion title="Pagamento com falha" icon="circle-xmark">
        Acionado quando a transação foi rejeitada ou recusada.

        Recomendações:

        * informar o usuário
        * permitir uma nova tentativa
        * redirecionar para outro meio de pagamento
      </Accordion>

      <Accordion title="Código de erro" icon="bug">
        Acionado quando o Payphone retorna um código de erro interno durante a criação ou o processamento do pagamento.
      </Accordion>

      <Accordion title="Erro HTTP" icon="triangle-exclamation">
        Acionado quando ocorre um erro de comunicação com o provedor, por exemplo um timeout, um problema de rede ou uma resposta inválida.
      </Accordion>

      <Accordion title="CTA enviado com sucesso" icon="paper-plane">
        Acionado quando o botão de pagamento foi enviado corretamente na conversa.

        Indica que a mensagem com o botão foi exibida com sucesso no WhatsApp. A partir deste output você pode conectar um nó de espera ou uma mensagem informando ao usuário que já pode concluir o pagamento.
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>

***

## Considerações importantes

<AccordionGroup>
  <Accordion title="O ambiente do nó deve corresponder ao do Payphone">
    Se você configurar o nó em `DEV`, a aplicação no **Payphone Developer** também deve estar em **Teste**.

    Se você configurar o nó em `PROD`, a aplicação no **Payphone Developer** deve estar em **Produção**.
  </Accordion>

  <Accordion title="Tratamento de pagamentos pendentes">
    Quando um pagamento fica inicialmente pendente, o agente informa o usuário sobre esse status por meio da mensagem correspondente.

    Se o Payphone atualizar o resultado posteriormente, o fluxo continua pelo output final correspondente:

    * **Pagamento bem-sucedido**
    * **Pagamento com falha**

    <Info>
      O estado pendente não é exposto como um output independente do nó.
    </Info>
  </Accordion>
</AccordionGroup>
