List Rewards - MX Documentation

List Rewards

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "rewards": [
    {
      "account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
      "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
      "balance_type": "EXPIRING_BALANCE",
      "balance": 1000,
      "created_at": "2025-02-13T18:08:00+00:00",
      "description": "A description of the reward.",
      "expires_on": "2020-02-28",
      "guid": "RWD-1234",
      "unit_type": "POINTS",
      "updated_at": "2023-06-01T19:18:06Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

GET

users

{user_guid}

members

{member_guid}

rewards

List Rewards

curl --request GET \
  --url https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_guid}/members/{member_guid}/rewards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "rewards": [
    {
      "account_guid": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
      "member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
      "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
      "balance_type": "EXPIRING_BALANCE",
      "balance": 1000,
      "created_at": "2025-02-13T18:08:00+00:00",
      "description": "A description of the reward.",
      "expires_on": "2020-02-28",
      "guid": "RWD-1234",
      "unit_type": "POINTS",
      "updated_at": "2023-06-01T19:18:06Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

Use this endpoint to list all the rewards associated with a specified member. Member guids are defined by MX.

Authorizations

Authorization

string

header

required

The MX Platform API requires basic access authentication using your client_id and api_key. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access.

Here's an example using curl to access v20250224. Replace https://int-api.mx.com/endpoint with the actual API endpoint you wish to access and your Base64 encoded client_id and api_key.

curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20250224

required

MX Platform API version.

Example:

"v20250224"

Path Parameters

user_guid

string

required

The unique identifier for a user, beginning with the prefix USR-.

member_guid

string

required

The unique id for a member.

Response

200 - application/json

rewards

object[]

Hide child attributes

rewards.account_guid

string

The unique identifier for an account. Defined by MX.

Example:

"ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1"

rewards.member_guid

string

The unique identifier for the member. Defined by MX.

Example:

"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

rewards.user_guid

string

The unique identifier for the user. Defined by MX.

Example:

"USR-fa7537f3-48aa-a683-a02a-b18940482f54"

rewards.balance_type

string

The type of balance associated with the reward, for example, BALANCE_TO_LEVEL, or TOTAL_BALANCE.

Example:

"EXPIRING_BALANCE"

rewards.balance

number

The current balance of the account.

PENDING transactions are typically not taken into account with the current balance, but this may not always be the case.

The balance will usually be a positive value for all account types. Asset-type accounts (CHECKING, SAVINGS, INVESTMENT) may have a negative balance if they are in overdraft.

Debt-type accounts (CREDIT_CARD, LOAN, LINE_OF_CREDIT, MORTGAGE) may have a negative balance if they are overpaid.

Example:

1000

rewards.created_at

string

The date and time the resource was created, represented in ISO 8601 format with a timestamp.

Example:

"2025-02-13T18:08:00+00:00"

rewards.description

string

The description for the reward as given by the data provider.

Example:

"A description of the reward."

rewards.expires_on

string

The date on which the balance expires.

Example:

"2020-02-28"

rewards.guid

string

The unique identifier for the reward. Defined by MX.

Example:

"RWD-1234"

rewards.unit_type

string

The units in which the balance is given, for example, MILES or POINTS.

Example:

"POINTS"

rewards.updated_at

string

The date and time at which the account was last updated.

Example:

"2023-06-01T19:18:06Z"

pagination

object

Hide child attributes

pagination.current_page

integer

The page delivered by the current response.

Example:

1

pagination.per_page

integer

The number of records delivered with each page.

Example:

25

pagination.total_entries

integer

The total number of records available.

Example:

1

pagination.total_pages

integer

The total number of pages available.

Example:

1