Objective: Accept / Refuse Conversions and Automatically Adjust an Amount
➜ Before you can automate the management of your conversions, make sure you have:
➜ Your advertiser API key (authentication token).
➜ The base API URL: https://rest.affilae.com
➜ The necessary access rights to your program.
API Documentation: https://rest.affilae.com/reference
All requests must include the header:
➜ Authorization: Bearer {YOUR_TOKEN}
➜ Amounts sent or received are expressed in cents (e.g. “100” = “1.00 €”).
➜ Dates are in UTC.
Retrieve a Conversion ID
Before accepting, refusing, or modifying a conversion, you must identify its internal Affilae ID.
Two methods are possible:
1. List your conversions
Use the endpoint GET /advertiser/conversions.list to retrieve your list of conversions.
You can filter by:
➜ status (“pending”, “accepted”, “refused”),
➜ period (“from”, “to”),
➜ customer identifier (“customerId”),
➜ or external identifier (“externalId”).
2. Get conversion details
Use GET /advertiser/conversions.info if you already know the external or customer identifier.
This route returns all information related to the conversion, including its internal Affilae ID.
Accept or Refuse a Conversion
Once the ID is known, you can automate validation decisions.
Accept a conversion
Use POST /advertiser/conversions.accept.
This route validates the conversion and marks it as “accepted”.
Required fields:
➜ “program”: the advertiser program ID
➜ “id”: the internal conversion ID
Refuse a conversion
Use POST /advertiser/conversions.refuse.
This route allows you to refuse a conversion (e.g. product return, fraud, test, etc.).
Required fields:
➜ “program”: program ID
➜ “id”: internal conversion ID
➜ “reason”: reason for refusal
Adjust the Amount of a Conversion (Cart Return)
In the case of a product return or cart adjustment, you can modify the amount of a pending conversion.
Use POST /advertiser/conversions.update.
Conditions:
➜ The conversion must have the “pending” status.
➜ The adjusted amount must be lower than the original amount.
➜ The amount must not have been modified before.
Required fields:
➜ “id”: internal conversion ID
➜ “amount”: new amount (in cents)
➜ “reason”: reason for adjustment (e.g. partial cart return)
Summary of routes:
➜ List conversions | GET: /advertiser/conversions.list
➜ Get a conversion | GET: /advertiser/conversions.info
➜ Accept a conversion | POST: /advertiser/conversions.accept
➜ Refuse a conversion | POST: /advertiser/conversions.refuse
➜ Adjust an amount | Automate conversion tracking via the API: /advertiser/conversions.update
Best Practices
➜ Keep the correspondence between your orders (externalId) and Affilae IDs to avoid duplicates.
➜ Store your API key securely and do not share it.
➜ Run your tests on a small volume of conversions before full deployment.
➜ The API enforces rate limits. Make sure to handle them in your calls.
➜ Keep logs of your API calls to facilitate tracking and support.
Need Help?
Our support team is available through your advertiser interface for any technical assistance.