Refund a sale
Called by your server when a sale you reported is refunded. amount is the total refunded on the invoice so far, in the sale’s minor unit; leave it out for the whole sale. A retry of the same total adds nothing and a higher total adds the difference. taxAmount is the total tax refunded so far; it is required for a partial refund of a sale with tax, and kept on the refund for your records only: the commission is reduced by the refunded share of the sale (amount over the sale’s amount), whatever the tax split. An unpaid commission is reduced pro rata; a paid one becomes a recovery for you to review. Every call is real: try it on a test directory.
Authentication
Your API key, sent as Authorization: Token <your API key>
Request
The directory’s Tracking ID, from Settings › Partner links (pp_trk_…).
The total refunded on the invoice so far, in the sale’s minor unit; left out for the whole sale.
The total tax refunded on the invoice so far, in the same unit. Required for a partial refund of a sale with tax; kept for your records, as the commission is reduced by the refunded share of the sale’s amount whatever the tax split.
Response
Refund recorded, or nothing new when the total was already recorded (refundId null)