Delete a recorded payment
DELETE
Deletes a payment recorded through this API (a test payment, a mistake) from every report. 404 when none. 300 requests a minute per API key.
Requires an API key holding revenue:write on the site. Session cookies and share links: 401.
header
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: revenue:write
siteId*stringpaymentId*stringYour billing system's id of the payment (order, transaction or invoice id), unique within the site
Match
^[!-~]{1,255}$No Content
curl -X DELETE 'https://pilotfox.app/api/v1/sites/string/payments/string'Example Response204
Empty