AIR MILES Cash

Real-time redemption of AIR MILES Cash Reward Miles at checkout for program Partners.

The purpose of this documentation is to provide a guide on how to integrate with the AIR MILES Cash API. As part of this documentation, we also include information on RESTful HTTPS requests/responses, error codes, the reconciliation process and integration environments.

Target audience

This material is intended to be used by a Partner wishing to integrate with the AIR MILES Cash API.

What is real-time redemption

The AIR MILES real-time platform provides Partners with a streamlined method for redeeming Collector’s AIR MILES Cash Reward Miles, online or in-store. Real-time redemption ensures your customer’s will be able to see their updated balances immediately before and after using their AIR MILES Cash Reward Miles.

Tip

Collectors maintain one account, but have two balances (AM Cash and Dream Miles).
Reward Miles earned in the AM Cash balance can be used as in-store redemptions at checkout.
95 AM Cash Reward Miles can be redeemed for $10, processed as an in-store purchase (at participating sponsor locations).
Collectors can redeem up to a maximum of $750 a day across all participating sponsors.

Service level objective

Please contact our Partner support team for details on our Service Level Agreement (SLA). Refer to our “Escalation Guide” for contact details.

Integration environments

There are two sets of environments used by partners to integrate with the real-time checkout platform. These environments are configured similarly for consistent production-level quality, whether the partner has deployed to production or is still performing non-production testing.

Environment	Domain	Description
Certification	https://cert.airmilesapis.ca	Contains production quality code and test data used for developing and testing 3rd party integrations.
Production	https://airmilesapis.ca	Contains production code and live user data for real-world 3rd party integrations.

Note

All integration environments must be accessed via HTTPS only.

Your AMRP project team

In preparation for launch, an AIR MILES team is pulled together to assist Partners with integration and setup. This team will provide the following services:

Consulting Partners on the best technical solution to support AIR MILES Issuance based on system compatibility.
Providing guidance for assessing Partner requirements, data exchange methods, and reconciliation.
As well as overseeing a broad range of activities to meet the requirements of launch, including:
- Planning
- Communications
- Delivery
- Execution
- Monitoring

Commonly used acronyms

Name	Definition
AMRP	AIR MILES Rewards Program: The loyalty program itself consisting both AIR MILES issuance an redemption processes.
AMRM	AIR MILES Rewards Miles: The loyalty program currency that Collectors earn and redeem for travel, merchandise and cash rewards.
RTC	Real-Time Checkout: An AIR MILES API platform specifically tailored for “Real-Time Issuance” & redemption of AIR MILES “Reward Miles”.
M2M	Machine-to-Machine: Refers to direct communication between devices using any communications channel, including wired and wireless. This includes CLIs, daemons, or services running on your back-end that self-authenticates and/or authorizes an application without collector interaction.
POS	Point-of-Sale: Refers to the software/hardware component that handles transactional messages, as well as processing AIR MILES issuances and reversals (return transactions).