Skip to main content

Rewards - Atrium API

Partners can use Atrium's rewards endpoints to gather rewards-related data like miles, cash, points, etc. These data can then be delivered to an end user or integrated into your product however you need.

Gathering rewards information is an aggregation-type process. This means the overall workflow is similar to standard aggregation, and the state of each process can be checked using the read member connection status endpoint.

Aggregation-type processes like fetching rewards data cannot be run simultaneously; rather, they must be run in a series.

Furthermore, when running multiple aggregation-type processes in succession, standard aggregation should always be performed first. This is because any aggregation-type process will prevent a new standard aggregation for the next three hours; however, running a standard aggregation has no effect on the fetching rewards information.

If a member already has a process running and you attempt to run an aggregation-type process on it, you may get one of two status codes:

  1. If an event of the same type is already running, you'll get a 202 Accepted status;
    • For example, you called fetch rewards when a rewards job is already running;
    • You can tell that a process is already running because the member's is_being_aggregated field will be true.
  2. If an event of a different type is running, you'll get a 409 Conflict status;
    • For example, you called fetch rewards when a standard aggregation is already running.

You must have the rewards feature enabled by MX. If the feature is not enabled, a 403 Forbidden error will be returned.

If an institution does not support rewards, a 400 Bad Request error will be returned.

info

Rewards aggregation is part of the Atrium API. Please read our API reference for critical information on authentication, security, standards, conventions, formats, etc. This is necessary to correctly access and integrate rewards data.

warning

Rewards data is a beta product, and this documentation is in draft form. The product and the documentation found here are subject to frequent changes.

Beta Header​

The features documented here are currently in a beta state. To access beta features, pass the beta Accept header in your requests.


_10
Accept: application/vnd.mx.atrium.beta+json

On this page