api-referencePOST

Rastreamento automatico disponivel

Se voce usa Stripe, LemonSqueezy ou Polar, nao precisa deste endpoint. Os pagamentos sao rastreados automaticamente quando seu provedor de pagamento esta conectado.
POSThttps://analytics.flowsery.com/api/v1/payments

Registe um pagamento e atribua receita. Envie o valor mais quaisquer identificadores que tenha, especialmente transactionId e visitorUid/sessionUid quando disponíveis.

Chave API (Bearer token)

Corpo da requisicao

ParametroTipoDescricao
amountnumberValor do pagamento. Este deve ser sempre enviado.
currencystringCodigo da moeda como "USD", "EUR", "GBP".
transactionIdstringIdentificador de transação estável utilizado para desduplicação.
visitorUidstringID de visitante Flowsery opcional, normalmente proveniente do cookie _fs_vid no seu próprio back-end.
sessionUidstringID de sessão Flowsery opcional, normalmente proveniente do cookie _fs_sid.
emailstringEndereco de e-mail do cliente.
namestringNome do cliente.
customerIdstringIdentificador do cliente do seu provedor de pagamento.
isRenewalbooleanDefina como true para pagamentos recorrentes. Padrao: false.
isRefundbooleanDefina como true para pagamentos reembolsados. Padrao: false.

A carga útil de sucesso contém apenas uma mensagem de confirmação.

Exemplo de requisicao (Node.js)
const handler = async (req, res) => {
  const _fs_vid = req.cookies._fs_vid;
  const _fs_sid = req.cookies._fs_sid;

  const response = await fetch(
    "https://analytics.flowsery.com/api/v1/payments",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${FLOWSERY_API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        amount: 29.99,
        currency: "USD",
        transactionId: "payment_456",
        visitorUid: _fs_vid,
        sessionUid: _fs_sid,
        email: "buyer@example.com",
      }),
    }
  );

  res.status(200).send("Payment tracked");
};
200
{
  "status": "success",
  "data": [{
    "message": "Payment recorded successfully"
  }]
}