curl --request POST \
--url https://v2.firstpromoter.com/api/v2/track/refund \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "<string>",
"uid": "<string>",
"event_id": "<string>",
"amount": "<string>",
"quantity": "<string>",
"sale_event_id": "<string>",
"skip_email_notification": true
}'
{
"id": 33847726,
"type": "refund",
"amount_cents": -1000,
"reward": {
"id": 10940148,
"status": "approved",
"amount": -200,
"unit": "cash",
"created_at": "2024-09-11T14:36:01.016Z",
"lead": {
"id": 20738339,
"state": "cancelled",
"email": "[email protected]",
"uid": null,
"customer_since": "2024-09-11T14:22:12.160Z",
"cancelled_at": "2024-09-11T15:07:46.174Z",
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-09-09T16:22:44.168Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"event_id": "test_sale_12340987_refund",
"conversion_amount": -1000,
"tier_level": 1,
"split_type": null
},
"lead": {
"id": 20738339,
"state": "cancelled",
"email": "[email protected]",
"uid": null,
"customer_since": "2024-09-11T14:22:12.160Z",
"cancelled_at": "2024-09-11T15:07:46.174Z",
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-09-09T16:22:44.168Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"promoter": {
"id": 3920164,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2022-04-26T15:28:24.800Z",
"temp_password": "xxxxxxxxxx",
"default_promotion_id": 4210919,
"pref": "db1znwe",
"default_ref_id": "8yi2epelut",
"note": "This is a note",
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": 577918,
"earnings_balance": {
"cash": 50744
},
"current_balance": {
"cash": 20044
},
"paid_balance": {
"cash": 30700
},
"auth_token": "xxxxxxxxxxxxxx"
}
}
The refund call is similar to the sale call. It works the same way, except that it generates negative commissions.
POST https://v2.firstpromoter.com/api/v2/track/refund
curl --request POST \
--url https://v2.firstpromoter.com/api/v2/track/refund \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "<string>",
"uid": "<string>",
"event_id": "<string>",
"amount": "<string>",
"quantity": "<string>",
"sale_event_id": "<string>",
"skip_email_notification": true
}'
{
"id": 33847726,
"type": "refund",
"amount_cents": -1000,
"reward": {
"id": 10940148,
"status": "approved",
"amount": -200,
"unit": "cash",
"created_at": "2024-09-11T14:36:01.016Z",
"lead": {
"id": 20738339,
"state": "cancelled",
"email": "[email protected]",
"uid": null,
"customer_since": "2024-09-11T14:22:12.160Z",
"cancelled_at": "2024-09-11T15:07:46.174Z",
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-09-09T16:22:44.168Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"event_id": "test_sale_12340987_refund",
"conversion_amount": -1000,
"tier_level": 1,
"split_type": null
},
"lead": {
"id": 20738339,
"state": "cancelled",
"email": "[email protected]",
"uid": null,
"customer_since": "2024-09-11T14:22:12.160Z",
"cancelled_at": "2024-09-11T15:07:46.174Z",
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-09-09T16:22:44.168Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"promoter": {
"id": 3920164,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2022-04-26T15:28:24.800Z",
"temp_password": "xxxxxxxxxx",
"default_promotion_id": 4210919,
"pref": "db1znwe",
"default_ref_id": "8yi2epelut",
"note": "This is a note",
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": 577918,
"earnings_balance": {
"cash": 50744
},
"current_balance": {
"cash": 20044
},
"paid_balance": {
"cash": 30700
},
"auth_token": "xxxxxxxxxxxxxx"
}
}
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
Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations
Success response
The response is of type object
.