Authorizations
API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys
Headers
Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations
Body
Email of the lead/sign-up. Required if uid is not provided.
Transaction or refund event ID. Required to avoid generating duplicate refunds.
The refund amount in cents. Used to calculate negative commissions/rewards.
uid of the lead added on signup tracking. Required if email is not provided.
This field is only required if the currency of the sale/refund is not the same as the one set on FirstPromoter settings. We'll automatically convert the amount from this currency to the default one set on your FirstPromoter account.
Number of subscriptions/items refunded. Optional if quantity is 1.
The event id of the sale for which the refund is processed. Should match the event_id from the sales tracking API call. Required for accurate tracking of multiple products or changing commission levels.
Set true to skip email notifications. Default is false.