Favorites an Offer
This route allows the connector to favorite a specific offer for a specific consumer.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id you used to create the given consumer
Unique ID of the offer on PayLead system.
Response
OK
- Option 1
- Option 2
- Option 3
Rate of reward used to calculate cashback amount
5
Enum in: HIGHEST, HIGH, NORMAL. For a contextual display (banner, carousel etc...), this value is set by the program manager on each offer
"HIGH"
Unique ID of the object.
"e2c32b4b-de61-459b-accf-a75f76247946"
Name of the object
- ACTIVE: The offer is available and your customers can benefit from it.
- COMPLETED: The campaign budget has been completely spent, the offer is no longer active.
- PUBLISHED: The offer is published but not yet active. You can choose to display them to tease your customers.
Enum in: CASHBACK, UNIQUE_COUPON, GENERIC_COUPON
CASHBACK, UNIQUE_COUPON, GENERIC_COUPON "CASHBACK"
Offer availability: ONLINE if the offer is online only. OFFLINE if the offer is offline only. BOTH if the offer is online and offline
ONLINE, OFFLINE, BOTH "ONLINE"
URL to reach the offer if the offer channel is ONLINE or BOTH
"https://www.mybrand.fr"
deprecated field
Deprecated field
deprecated field
Has the consumer already consumed the coupon of the current offer? If true, yes. If false, no.
true
- QR: QR code
- EAN: Bar code
- CODE: Full text (alpha num) code
Deprecated field
Generic code allowing the consumer to benefit from the offer
deprecated field
Object creation datetime
"2019-01-31T15:16:15.523309+00:00"
description
End date of the offer. A transaction has to be executed before (inclusive) this date to be able to generate cashback for the consumer.
"2017-12-26T23:00:00+00:00"
TRUE if the offer is liked by consumer, FALSE if not
true
TRUE if the object is active, FALSE if not
true
Has the consumer already consumed the coupon of the current offer? If true, yes. If false, no.
true
TRUE if the offer is liked by consumer, FALSE if not
true
deprecated field
Legal terms
Maximum transaction amount for this offer. the maximum reward for this offer is max_amount x cashback_rate
250
The maximum number of rewards that can be obtained by a consumer, if "None", it's unlimited, on a given offer
Merchant that has created the offer
Minimum amount for a transaction to be able to generate a reward for the consumer
40
UUID: If the offer is promoting a selection of stores belonging to a specific network, ID of the network. Else, null
"739c5ba7-8831-4664-9ce3-73e9f1e50c09"
deprecated field
- Option 1
- Option 2
Program manager object.
Offer publication datetime. An offer can be published before its starting date (for teasing purposes)
"2019-01-01T00:00:00+00:00"
Unique reference of the offer. Human readable, made out from the concatenation of the brand name + creation date + increment.
"MYBRAND-20180220-001"
Segments of offers
If this flag is true, the transaction must come from the default bank of the program to generate a reward
Date (ex. 2017-12-26T23:00:00+00:00): Start date of the offer. A transaction has to be executed after (inclusive) this date to be able to generate cashback for the consumer.
"2018-12-21T00:00:00+00:00"
Sum of transaction amounts
4682.67
number of consumer
Deprecated field
deprecated field