Events

Record a payment, renewal or refund

Attributes revenue to a visitor so it shows up in revenue metrics and the visitor profile. Set isRenewal for recurring charges and isRefund to reverse one.

post/payments

Request

  • Base URL: https://analytics.flowsery.com/analytics/api/v1
  • URL: https://analytics.flowsery.com/analytics/api/v1/payments
  • Auth: HTTP bearer

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Request body

amountnumber required

Major units, e.g. 49.90. On a refund, the amount refunded; 0 clears an earlier refund.

currencystring

ISO 4217 code. Defaults to USD.

transactionIdstring

Your own payment id, unique across Flowsery. A second payment with the same id answers 409. Required to refund or delete the payment later.

emailstring
namestring
customerIdstring
isRenewalboolean

Marks a recurring charge.

isRefundboolean

Reverses an earlier payment.

timestampstring date-time

Defaults to now.

websiteIdstring
domainstring
visitorUidstring
sessionUidstring
timezonestring

Response

Payment recorded

status'success' required

Changes

No recorded changes to this operation across all 1 revision of this API.