Banyan Event Types
Webhooks can be registered for both the Enrich and Confirm for CLO products. For Enrich, you would be able to receive enriched transactions as Banyan's algorithm matches them. For CLO, you could subscribe to both fulfilled and unfulfilled offer redemptions.
| Event Type | Description | Additional Notes |
|---|---|---|
| enrich.enriched_transaction | This event will provide both the transaction you sent back to Banyan and the receipt contents that were matched to it. There is also meta data around match timestamp and enriched transaction ID that will assist with dealing with duplicate records. | |
| enrich.consumer_match | This event will provide the FinX consumer token for the match as well as the receipt that was matched to that tokens attribute. Each record will also have the match timestamp as well as a unique cmx id. | |
| confirm.clo.offer_redemption_fulfilled | This event will provide the enriched transaction after a match in addition to the offer details and "result" of the offer assessment. If the offer requirements were fulfilled and there was allowance left for this specific user to receive the reward, it will be categorized as this event type. | Relevant only for Card Linked Offer campaigns run through Banyan |
| confirm.clo.offer_redemption_unfulfilled | This event will provide the enriched transaction after a match in addition to the offer details and "result" of the offer assessment. If the offer requirements were not fulfilled or there wasn't allowance left for this specific user to receive the reward, it will be categorized as this event type. | Relevant only for Card Linked Offer campaigns run through Banyan |
| confirm.clo.consumer_offer_redemption_fulfilled | This event will provide the consumer match record alongside the offer details and result when any of the items in the receipt qualified for the reward. | Relevant only for Card Linked Offer campaigns run through Banyan |
| confirm.clo.consumer_offer_redemption_unfulfilled | This event will provide the consumer match record alongside the offer details and result when all of the items in the receipt did not qualify for the reward. | Relevant only for Card Linked Offer campaigns run through Banyan |
Updated 7 days ago
What’s Next
Learn about different event types