Use Transaction Intents to connect your transaction data to the Imprint rewards platform and take advantage of its full potential:

  • Dynamic Rewards Calculation: set the amount of rewards earned on a transaction based on your internal calculation (e.g. item or category-level rewards rates, promotions, etc.), or simply share the order data and use the Imprint platform to configure your calculation logic;

  • Additional Offers and Benefits: trigger additional rewards based on qualification criteria (e.g., certain types of purchases or behaviors);

  • Transaction Matching: provide criteria for Imprint to search for related transactions (e.g., purchases at complementary businesses) and trigger rewards;

  • Transaction Enrichment: provide transaction details (e.g., order lines, logos, images, travel dates, etc.) to display in the Imprint customer experience;

  • And more …

In just one or (at most) two API requests, you can provide your customers with a truly differentiated rewards experience.

​
Step 1: Create transaction intent

Once the transaction has been completed on your platform, immediately make an API request to Imprint to create a corresponding Transaction Intent.

  • POST request to v2/transaction_intents including several required fields (e.g., Currency, Amount, Customer ID) and the metadata object. The metadata schema will be provided by your Imprint team depending on the above features selected and enabled for your program.

  • Responds with Intent ID and Status. If status equals "REQUIRES_CONFIRMATION" please proceed to Step 2 below.

​
Step 2: Confirm or cancel transaction intent (optional, depending on the program)

Depending on the above Imprint features enabled, partners with “multi-step” transactions may be required to provide an update with the final transaction outcome. If the transaction intent is updated to CONFIRMED status, Imprint will enable the loyalty and rewards experiences. Otherwise,CANCELED will result in no further action.

  • POST request to /v2/transaction_intents/{intent_id} including the final status and any other details that may have changed, e.g. amount, anything within the metadata object, etc.

  • Responds with the latest status and all other details

​
Step 3: List or retrieve transaction intents (optional)

Finally, there are two ways to read existing Transaction Intents.

List Transaction Intents

  • GET request to /v2/transaction_intents including the Customer ID

  • Responds with a paginated list of all Transaction Intents associated with the Customer ID

Retrieve Transaction Intents