API reference / Analytics
Delete recorded payments
Deletes the payments and refunds that the Payment API recorded: one by its transactionId, all of one visitor, or all in a time range. Give at least one of them. When you give several, a payment must match all of them. Payments that Troopy read from a connected provider stay.
delete
/api/v1/analytics/paymentsOther ways to call it
CLI
troopy analytics payments deleteMCP toolNone. Call it over REST or with the CLI.
Rate limit60 calls in 60 seconds, for each key
RetriesSend an
Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Query parameters
transactionIdstringAt least 1 characters · At most 255 characters
visitorstringThe visitor's id, as the script or SDK sent it
fromstringFrom this time
date-time
tostringUp to this time, not included
date-time
Response
200 · application/jsondata*object1 properties
deleted*integerThe payments and refunds deleted
Errors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.