Skip to content

Track the sale with client_ref

When the sale happens through the checkout link (the card path, and also PIX, boleto and BDM), you can send a code from your system in the link itself — the order, session or customer id — and get it back in the webhook and the API. That is how you link the Auryon sale to the record on your side.

Add the client_ref parameter to the offer’s checkout link:

https://checkout.auryon369.com.br/ABC12345?client_ref=order-8841
  • Format: letters, digits, - and _, from 1 to 100 characters. A value outside this is ignored (the sale goes through normally, just without the client_ref).
  • It can go along with UTMs: ?client_ref=order-8841&utm_source=instagram&utm_campaign=launch.
  • It works for every payment method: PIX, boleto, Brazilian card, international card and local methods, and BDM. The code is stored before the buyer chooses how to pay.
  • If the buyer leaves and comes back to the checkout in the same browser without the parameter, the stored code still applies.
Where Field
V1 webhook (sale and payment events) data.object.tracking.client_ref
V1 webhook checkout.session.abandoned data.object.tracking.client_ref
Legacy webhook TRANSACTION_* trackProps.client_ref
Legacy webhook SESSION_ABANDONED data.order.trackProps.client_ref (where the old format keeps this event’s trackProps)
API v1 GET /v1/transactions and /v1/transactions/{id} tracking.client_ref
API v1 — find by code GET /v1/transactions?client_ref=order-8841

The tracking block also carries the link’s UTMs, src and sck, only those that exist:

{
"tracking": {
"client_ref": "order-8841",
"utm_source": "instagram",
"utm_campaign": "launch"
}
}

For a sale with none of these, tracking is empty ({}) — the field is always present.

Upsell, downsell, order bump and subscriptions

Section titled “Upsell, downsell, order bump and subscriptions”
  • An order bump is the same sale: the same tracking.
  • Upsells and downsells are born with the main sale’s client_ref and UTMs.
  • Subscription renewals are born with the first sale’s client_ref and UTMs.
  • The abandoned cart event carries the client_ref of the link where the buyer left their email.

The client_ref is kept even when the buyer turns off ad measurement in the cookie notice: it is your own reference, not ad data. UTMs are not stored in that case.

The client_ref travels in the URL, so the buyer can edit it. Treat it as a reference to find the record in your system, never as proof of anything:

  • check that the code exists and is yours before using it;
  • check the sale’s amount and product against what you expected for that order;
  • to grant access, keep using the transaction.paid event with a verified signature.

Do not put personal data in client_ref (email, tax ID, phone): use an opaque id from your system.