Enregistrer un paiement

api-referencePOST

Suivi automatique disponible

Si vous utilisez Stripe, LemonSqueezy ou Polar, vous n'avez pas besoin de ce point de terminaison. Les paiements sont suivis automatiquement lorsque votre fournisseur de paiement est connecte.

POSThttps://analytics.flowsery.com/analytics/api/v1/payments

Enregistrez un paiement et attribuez des revenus. Envoyez le montant ainsi que tous les identifiants dont vous disposez, en particulier transactionId et VisitorsUid/sessionUid lorsqu'ils sont disponibles.

Jeton Bearer (jeton workspace ou clé API de site)

Les jetons d'espace de travail nécessitent un sélecteur de site Web

Les jetons de l'API Workspace peuvent accéder à tous les sites Web de l'espace de travail. Transmettez <code>websiteId</code> ou <code>domain</code> pour que Flowsery sache quel site Web interroger ou muter. Les clés API de site Web sont déjà limitées à un seul site Web, le sélecteur peut donc être omis.

Sélecteur de site Web

Parametre	Taper	Description
`websiteId`	`string`	ID de site Web à utiliser avec un jeton API d'espace de travail. Incluez ce champ dans le corps JSON, sauf si vous fournissez domain. Omettre lors de l'authentification avec une clé API de site Web.
`domain`	`string`	Site Web domain à utiliser avec un jeton API d'espace de travail lorsque websiteId n'est pas fourni. Incluez ce champ dans le corps JSON. Omettre lors de l'authentification avec une clé API de site Web.

Corps de la requete

Parametre	Taper	Description
`amount`	`number`	Montant du paiement. Cela devrait toujours être envoyé.
`currency`	`string`	Code de devise tel que "USD", "EUR", "GBP".
`transactionId`	`string`	Identificateur de transaction stable utilisé pour la déduplication.
`visitorUid`	`string`	ID de visiteur Flowsery facultatif, provenant généralement du cookie _fs_vid sur votre propre backend.
`sessionUid`	`string`	ID de session Flowsery facultatif, provenant généralement du cookie _fs_sid.
`email`	`string`	Adresse e-mail du client.
`name`	`string`	Nom du client.
`customerId`	`string`	Identifiant client provenant de votre fournisseur de paiement.
`isRenewal`	`boolean`	Definissez sur true pour les paiements recurrents. Par defaut : false.
`isRefund`	`boolean`	Definissez sur true pour les paiements rembourses. Par defaut : false.

La charge utile de réussite contient uniquement un message de confirmation.

Exemple de requete (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/analytics/api/v1/payments",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${FLOWSERY_API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        websiteId: process.env.FLOWSERY_WEBSITE_ID,
        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"
  }]
}