Guia de Configuração para Clientes

Este documento explica como configurar um Client, criar Offers associadas e acompanhar Transactions no Paystation. O foco é permitir que o time técnico e de operações do cliente replique a mesma configuração em produção.

1. Conceitos principais

Client: container principal de configuração (webhooks, dados da empresa, checkout, termos e métodos de pagamento padrão).
Offer: produto/serviço vendável (título, preço, imagem, regras específicas de pagamento) sempre vinculado a um Client.
Transaction: registro de uma venda efetiva, unindo Client, Offer, Customer e meio de pagamento em um único payload JSON.

2. Client - Configuração geral

2.1. Acesso à tela de Client

Navegue em: Clients → Editing Item in Clients.
Use busca/filtro para localizar o client ou clique em New Client para criar um novo.

2.2. Identificação do Client

Status
- Define se o Client está ativo para vendas.
- Valores comuns: Draft (rascunho) e Published (ativo).
Name
- Nome de exibição do Client (ex.: Mario Trentim).
Client Token
- Identificador único curto (slug), usado em URLs e integrações (ex.: mario-trentim).
Integration Type
- Tipo de integração principal (ex.: Collection, Subscription, etc.).
- Afeta o comportamento padrão de cobrança (pagamento único x recorrência).

2.3. Webhook Config

Webhook Token
- Token secreto para assinar/validar chamadas de webhook no backend do cliente.
Webhook Offer URL
- Endpoint chamado em eventos ligados a Offers (ex.: criação de oferta, alteração de status), quando aplicável.
Webhook Notification URL (Deprecated)
- Campo legado, mantido apenas para compatibilidade.
- Prefira sempre usar Webhook Notification Urls.
Webhook Notification Urls
- Lista de endpoints que recebem notificações de eventos de transação (criação, pagamento, chargeback, etc.).
- Permite múltiplas URLs (ex.: um n8n e um endpoint próprio do cliente).

2.4. Company Info

Email: endereço de contato exibido no checkout e comunicações.
Number: telefone de suporte.
Address: endereço completo da empresa.
CNPJ: documento fiscal usado em notas e comprovantes.

2.5. Checkout Config

Show Header
- Liga/desliga o cabeçalho visual do checkout.
Logo
- Imagem principal exibida no topo do checkout (formato recomendado: PNG ou SVG).
Favicon
- Ícone usado na aba do navegador.

2.6. Terms Config

Show Terms
- Se habilitado, exibe checkbox/aviso de termos de uso no checkout.
Terms
- Arquivo PDF de termos selecionado (ex.: Termos De Uso - Modern Pmo).

2.7. Payment Config (padrões do Client)

Boleto Expiration Days
- Número de dias até o vencimento do boleto (ex.: 3, 5, 7).
Pix Expiration Minutes
- Tempo de expiração do QR Code Pix em minutos (ex.: 10).

Esses valores podem ser sobrescritos em nível de Offer conforme a necessidade comercial.

3. Offers - Ligando produtos ao Client

3.1. Acesso à tela de Offers

Navegue em: Offers → Editing Item in Offers.
Busque uma Offer existente ou clique em New Offer.

3.2. Identificação da Offer

Offer ID *
- Identificador único da oferta (slug), usado em integrações e URL (ex.: combo-todos-os-programas-e-treinamentos).
Client ID *
- Client ao qual a Offer pertence (ex.: Mario Trentim).
- Herda webhooks, dados fiscais e configurações de checkout do Client.
Status
- Draft: oferta em edição, não disponível no checkout público.
- Published: oferta ativa, pode receber tráfego.
Show Offer
- Enabled: oferta visível em listagens/catálogos.
- Disabled: oferta oculta, mas acessível por link direto (útil para campanhas).
Image
- Banner principal da oferta exibido no checkout.
Title *
- Nome comercial (ex.: Combo - Todos os Programas e Treinamentos).
Description
- Texto explicando o que está incluído (cursos, mentoria, benefícios, etc.).
Price *
- Valor em centavos com ponto como separador decimal (ex.: 11967.12).

3.3. Payment Methods (por Offer)

Cada Offer pode customizar métodos de pagamento, sobrescrevendo parte do padrão do Client.

Card Config

Creditcard: habilita/desabilita cartão de crédito.
Max Installment First: destaca a maior parcela disponível por padrão.
Installments: máximo de parcelas permitido (ex.: 12).
Non Interest Installments: quantidade de parcelas sem juros (ex.: 1).
Interest Rate: taxa de juros mensal aplicada nas demais parcelas (ex.: 1.98).
Creditcard Instructions: instruções adicionais (texto livre).

Boleto Config

Boleto: habilita/desabilita boleto bancário.
Boleto Instructions: mensagem exibida junto ao boleto (prazo, compensação).
Boleto Discount Type: percentage ou amount.
Boleto Discount: valor ou percentual de desconto.

Pix Config

Pix: habilita/desabilita pagamento via Pix.
Pix Instructions: orientação ao cliente sobre uso do Pix e prazo.
Pix Discount Type: percentage ou amount.
Pix Discount: valor ou percentual de desconto.

3.4. Offer URL

Campo Offer URL mostra o link público da oferta, por exemplo: https://paystation-client.quero.space/mario-trentim/combo-todos-os-programas-e-treinamentos
Use este link em páginas de vendas, anúncios e e-mails.

3.5. Fluxo recomendado para criar uma Offer

Configurar o Client (Webhooks, Company Info, Checkout, Terms, Payment Config).
Criar a Offer selecionando o Client ID correto.
Definir imagem, título, descrição e preço.
Ajustar Card Config, Boleto Config e Pix Config conforme a política comercial.
Publicar a Offer (Status = Published, Show Offer = Enabled) e validar o fluxo usando a Offer URL.

4. Transactions - Visão e payloads

4.1. Listagem de Transactions

Navegue em: Transactions.
A lista mostra, para cada transação:
- Name (nome do Client ou da Offer, conforme configuração).
- Status (paid, unpaid, waiting_refund, refunded, etc.).
- Type (card, pix, boleto).
- Customer Email.
- Document.
Use filtros e busca para encontrar transações específicas.

4.2. Detalhe de uma Transaction (campos principais)

Client: client associado (ex.: allevo).
Customer Email: e-mail usado pelo comprador.
Date Created / Date Updated: datas de criação e última atualização.
Paid At: data/hora de confirmação de pagamento.
Type: card, pix ou boleto.
Status: paid, unpaid, waiting_refund, etc.
Amount: valor total da transação (já com juros/descontos).
Installments: número de parcelas (para cartão).

4.3. Seções de dados estruturados

Offer Data
- offer: ID da offer (ex.: curso-rpn).
- external_offer_id: ID usado pelo sistema do cliente (opcional).
Customer Info / Customer Data
- JSON com nome, documento, e-mail, telefone e endereço.
Order Info / Order Summary
- JSON com subTotalPrice, discount, interest e totalPrice.
Order Bumps
- Lista de itens adicionais (array de objetos) quando houver upsells/bump offers.
Coupon
- Cupom aplicado na transação (se existir).
Payment Gateway
- payment_gateway_id: ID interno.
- acquirer_name: xpto.
- acquirer_id: ID no adquirente.
- payment_data: JSON com detalhes do meio de pagamento.

5. Exemplos de payload (JSON)

5.1. Transaction com cartão de crédito (fake)

json

{
  "id": "txn_1234567890",
  "client": "mario-trentim",
  "offer": "curso-rpn",
  "external_offer_id": "CURSO_RPN_001",
  "type": "card",
  "status": "paid",
  "amount": 119640,
  "currency": "BRL",
  "installments": 12,
  "created_at": "2026-01-22T16:54:10Z",
  "updated_at": "2026-01-22T16:55:02Z",
  "paid_at": "2026-01-22T16:54:30Z",
  "customer": {
    "id": "cus_987654321",
    "name": "Renata Cliente",
    "document": "12345678901",
    "email": "renata.cliente+fake@example.com",
    "phone": "+5511999990000",
    "address": {
      "street": "Avenida Sao Joao",
      "number": "1900",
      "neighborhood": "Jardim das Colinas",
      "zip_code": "12242000",
      "complement": "",
      "city": "Sao Jose dos Campos",
      "state": "SP",
      "country": "BR"
    },
    "custom_fields": {}
  },
  "order": {
    "summary": {
      "subTotalPrice": 99700,
      "discount": 0,
      "interest": 19940,
      "totalPrice": 119640
    },
    "order_bumps": [],
    "coupon": null
  },
  "payment_gateway": {
    "gateway_id": "3400158",
    "acquirer_name": "xpto",
    "acquirer_id": "ch_fake_rNV14pySyLf12345",
    "payment_data": {
      "installments": 12,
      "refusal_message": null,
      "refusal_reason": null,
      "card": {
        "id": 1042155,
        "holder_name": "Renata M Cliente",
        "first_digits": "555555",
        "last_digits": "3333",
        "brand": "Mastercard",
        "expiration_month": 9,
        "expiration_year": 2033,
        "type": "credit"
      }
    }
  }
}

Guia de Configuração para Clientes ​

1. Conceitos principais ​

2. Client - Configuração geral ​

2.1. Acesso à tela de Client ​

2.2. Identificação do Client ​

2.3. Webhook Config ​

2.4. Company Info ​

2.5. Checkout Config ​

2.6. Terms Config ​

2.7. Payment Config (padrões do Client) ​

3. Offers - Ligando produtos ao Client ​

3.1. Acesso à tela de Offers ​

3.2. Identificação da Offer ​

3.3. Payment Methods (por Offer) ​

Card Config ​

Boleto Config ​

Pix Config ​

3.4. Offer URL ​

3.5. Fluxo recomendado para criar uma Offer ​

4. Transactions - Visão e payloads ​

4.1. Listagem de Transactions ​

4.2. Detalhe de uma Transaction (campos principais) ​

4.3. Seções de dados estruturados ​

5. Exemplos de payload (JSON) ​

5.1. Transaction com cartão de crédito (fake) ​