Email Templates

Templates locais versionados na repo. Use payload.email.template e payload.email.variables; não use templateId para esses templates.

Baixar catálogo em JSON ou abrir exemplos no Scalar.

payment-approved

Confirma que o pagamento foi aprovado e orienta o usuário a continuar no app.

Obrigatórias

appUrl

Opcionais

appNamecustomerNameorderIdproductNamepaymentAmountpaymentMethodpaidAt

Variáveis

  • appUrl (obrigatória) - URL principal do app ou da tela relacionada ao pagamento. Exemplo: https://app.ailian.com.br
  • appName (opcional) - Nome exibido do produto. Usa Ailian quando omitido. Exemplo: Ailian
  • customerName (opcional) - Nome do cliente ou destinatário. Exemplo: Marina Costa
  • orderId (opcional) - Identificador do pedido, assinatura ou checkout. Exemplo: PED-2026-0001
  • productName (opcional) - Nome do plano, pacote de creditos ou item comprado. Exemplo: Ghostwriter Starter
  • paymentAmount (opcional) - Valor do pagamento já formatado. Exemplo: R$ 199,90
  • paymentMethod (opcional) - Forma de pagamento exibida ao cliente. Exemplo: Cartao de credito
  • paidAt (opcional) - Data/hora de aprovação já formatada. Exemplo: 11/05/2026 18:30

Exemplo de payload.email

{
  "email": {
    "template": "payment-approved",
    "subject": "Pagamento aprovado",
    "variables": {
      "appName": "Ailian",
      "customerName": "Marina Costa",
      "orderId": "PED-2026-0001",
      "productName": "Ghostwriter Starter",
      "paymentAmount": "R$ 199,90",
      "paymentMethod": "Cartao de credito",
      "paidAt": "11/05/2026 18:30",
      "appUrl": "https://app.ailian.com.br/billing"
    }
  }
}

invoice-issued

Informa que a nota fiscal foi emitida e entrega o link para acesso/download.

Obrigatórias

invoiceUrl

Opcionais

appNamecustomerNameinvoiceNumberproductNameinvoiceAmountissuedAtappUrl

Variáveis

  • invoiceUrl (obrigatória) - URL pública ou autenticada para abrir/baixar a nota fiscal. Exemplo: https://app.ailian.com.br/invoices/nf-001
  • appName (opcional) - Nome exibido do produto. Usa Ailian quando omitido. Exemplo: Ailian
  • customerName (opcional) - Nome do cliente ou destinatário. Exemplo: Marina Costa
  • invoiceNumber (opcional) - Numero da nota fiscal emitida. Exemplo: NF-e 1024
  • productName (opcional) - Nome do plano, pacote de creditos ou item faturado. Exemplo: Creditos Ailian 20K
  • invoiceAmount (opcional) - Valor da nota fiscal ja formatado. Exemplo: R$ 199,90
  • issuedAt (opcional) - Data/hora de emissão já formatada. Exemplo: 11/05/2026 18:45
  • appUrl (opcional) - URL alternativa para acessar a área financeira no app. Exemplo: https://app.ailian.com.br/billing

Exemplo de payload.email

{
  "email": {
    "template": "invoice-issued",
    "subject": "Nota fiscal emitida",
    "variables": {
      "appName": "Ailian",
      "customerName": "Marina Costa",
      "invoiceNumber": "NF-e 1024",
      "productName": "Creditos Ailian 20K",
      "invoiceAmount": "R$ 199,90",
      "issuedAt": "11/05/2026 18:45",
      "invoiceUrl": "https://app.ailian.com.br/invoices/nf-001",
      "appUrl": "https://app.ailian.com.br/billing"
    }
  }
}