Redeem Points API

Redeem Points

curl --request POST \
  --url https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RelationReference": "jane.doe@example.com",
  "Amount": 500,
  "Points": 500,
  "MerchantName": "Amazon",
  "LoyaltyTxnType": 30,
  "TransactionCurrency": "DEFAULT",
  "RelationType": 4,
  "ProgramId": 19
}
'

import requests

url = "https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints"

payload = {
    "RelationReference": "jane.doe@example.com",
    "Amount": 500,
    "Points": 500,
    "MerchantName": "Amazon",
    "LoyaltyTxnType": 30,
    "TransactionCurrency": "DEFAULT",
    "RelationType": 4,
    "ProgramId": 19
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    RelationReference: 'jane.doe@example.com',
    Amount: 500,
    Points: 500,
    MerchantName: 'Amazon',
    LoyaltyTxnType: 30,
    TransactionCurrency: 'DEFAULT',
    RelationType: 4,
    ProgramId: 19
  })
};

fetch('https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints', 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://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'RelationReference' => 'jane.doe@example.com',
    'Amount' => 500,
    'Points' => 500,
    'MerchantName' => 'Amazon',
    'LoyaltyTxnType' => 30,
    'TransactionCurrency' => 'DEFAULT',
    'RelationType' => 4,
    'ProgramId' => 19
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints"

	payload := strings.NewReader("{\n  \"RelationReference\": \"jane.doe@example.com\",\n  \"Amount\": 500,\n  \"Points\": 500,\n  \"MerchantName\": \"Amazon\",\n  \"LoyaltyTxnType\": 30,\n  \"TransactionCurrency\": \"DEFAULT\",\n  \"RelationType\": 4,\n  \"ProgramId\": 19\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"RelationReference\": \"jane.doe@example.com\",\n  \"Amount\": 500,\n  \"Points\": 500,\n  \"MerchantName\": \"Amazon\",\n  \"LoyaltyTxnType\": 30,\n  \"TransactionCurrency\": \"DEFAULT\",\n  \"RelationType\": 4,\n  \"ProgramId\": 19\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"RelationReference\": \"jane.doe@example.com\",\n  \"Amount\": 500,\n  \"Points\": 500,\n  \"MerchantName\": \"Amazon\",\n  \"LoyaltyTxnType\": 30,\n  \"TransactionCurrency\": \"DEFAULT\",\n  \"RelationType\": 4,\n  \"ProgramId\": 19\n}"

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

{
  "results": {
    "IsSucessful": true,
    "ErrorCode": "000",
    "ExceptionMessage": "Success",
    "ReturnObject": "3FA85F64-5717-4562-B3FC-2C963F66AFA6"
  }
}

POST

lbms-ingress

pg-lm

API

RedeemPoints

Redeem Points

curl --request POST \
  --url https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RelationReference": "jane.doe@example.com",
  "Amount": 500,
  "Points": 500,
  "MerchantName": "Amazon",
  "LoyaltyTxnType": 30,
  "TransactionCurrency": "DEFAULT",
  "RelationType": 4,
  "ProgramId": 19
}
'

import requests

url = "https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints"

payload = {
    "RelationReference": "jane.doe@example.com",
    "Amount": 500,
    "Points": 500,
    "MerchantName": "Amazon",
    "LoyaltyTxnType": 30,
    "TransactionCurrency": "DEFAULT",
    "RelationType": 4,
    "ProgramId": 19
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    RelationReference: 'jane.doe@example.com',
    Amount: 500,
    Points: 500,
    MerchantName: 'Amazon',
    LoyaltyTxnType: 30,
    TransactionCurrency: 'DEFAULT',
    RelationType: 4,
    ProgramId: 19
  })
};

fetch('https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints', 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://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'RelationReference' => 'jane.doe@example.com',
    'Amount' => 500,
    'Points' => 500,
    'MerchantName' => 'Amazon',
    'LoyaltyTxnType' => 30,
    'TransactionCurrency' => 'DEFAULT',
    'RelationType' => 4,
    'ProgramId' => 19
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints"

	payload := strings.NewReader("{\n  \"RelationReference\": \"jane.doe@example.com\",\n  \"Amount\": 500,\n  \"Points\": 500,\n  \"MerchantName\": \"Amazon\",\n  \"LoyaltyTxnType\": 30,\n  \"TransactionCurrency\": \"DEFAULT\",\n  \"RelationType\": 4,\n  \"ProgramId\": 19\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"RelationReference\": \"jane.doe@example.com\",\n  \"Amount\": 500,\n  \"Points\": 500,\n  \"MerchantName\": \"Amazon\",\n  \"LoyaltyTxnType\": 30,\n  \"TransactionCurrency\": \"DEFAULT\",\n  \"RelationType\": 4,\n  \"ProgramId\": 19\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://loyalife-api.xoxoday.in/lbms-ingress/pg-lm/API/PG/RedeemPoints")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"RelationReference\": \"jane.doe@example.com\",\n  \"Amount\": 500,\n  \"Points\": 500,\n  \"MerchantName\": \"Amazon\",\n  \"LoyaltyTxnType\": 30,\n  \"TransactionCurrency\": \"DEFAULT\",\n  \"RelationType\": 4,\n  \"ProgramId\": 19\n}"

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

{
  "results": {
    "IsSucessful": true,
    "ErrorCode": "000",
    "ExceptionMessage": "Success",
    "ReturnObject": "3FA85F64-5717-4562-B3FC-2C963F66AFA6"
  }
}

Deducts a specified number of points from a member’s balance to fulfil a redemption — for a hotel booking, flight, gift card, or charitable donation. Partial redemption is not supported — points must cover the full transaction value. The points-to-currency conversion rate is configurable per program — there is no fixed global rate. Confirm the rate with your Xoxoday implementation contact to calculate Points from the cart Amount correctly. This call is irreversible on its own; if downstream fulfilment fails after points are deducted, you must call Reversal Points to restore the balance. Always call Check Availability first, and store the ExternalReference UUID returned here immediately.

Save the ExternalReference UUID immediately. If downstream fulfillment fails, you’ll need it to call Reversal Points and restore the member’s balance.

LoyaltyTxnType Values

Value	Category
`4`	Miles / Points Transfer
`5`	Hotel
`6`	Air / Flight
`19`	Charity
`30`	Gift Card

Additional LoyaltyTxnType values may be configured for your program. Use etc. values from your onboarding documentation if your redemption category is not listed above.

Responses

200 — Success

Path	Type	Description
`results.IsSucessful`	boolean	`true`
`results.ErrorCode`	string	`000`
`results.ExceptionMessage`	string	`Success`
`results.ReturnObject`	string (UUID)	`ExternalReference` for this transaction. Store for potential reversal.

Error Codes

Code	ExceptionMessage	Cause
`000`	Success	Points deducted; redemption details in the response
`103`	Member does not exist	`RelationReference` not found in the program
`107`	Member status is not Active	Member has not been activated
`113`	Member is cancelled	Member account is cancelled
`114`	Member is suspended	Member account is suspended
`120`	Points must be greater than zero	`Points` value is 0 or negative
`208`	Merchant name missing	`MerchantName` not provided in the request
`301`	Failed to redeem points	Redemption operation failed
`302`	Insufficient points	Points requested exceed the member’s available balance
`997`	Exception occurred	Unexpected server-side error
`999`	Bad request	Malformed payload or missing required fields

Authorizations

Authorization

string

header

required

JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.

Body

application/json

RelationReference

string

required

Example:

"jane.doe@example.com"

Amount

number

required

Monetary value equivalent of the redemption

Example:

500

Points

integer

required

Number of points to deduct

Example:

500

MerchantName

string

required

Merchant or redemption channel name

Example:

"Amazon"

LoyaltyTxnType

enum<integer>

required

Redemption category. 4=Miles/Points Transfer, 5=Hotel, 6=Air, 19=Charity, 30=Gift Card

Available options:

4,

5,

6,

19,

30

Example:

30

TransactionCurrency

string

required

Example:

"DEFAULT"

RelationType

integer

required

Use 4 for customers

Example:

4

ProgramId

integer

required

Example:

19

Response

200 - application/json

Points redeemed — ReturnObject is the ExternalReference UUID

results

object

Show child attributes

⌘I

Overview

Core Concepts

Authentication

Member Management

OTP

Transactions

Points Redemption

Redeem Points

LoyaltyTxnType Values

Responses

Error Codes

Authorizations

Body

Response

​LoyaltyTxnType Values

​Responses

​Error Codes

Authorizations

Body

Response

LoyaltyTxnType Values

Responses

Error Codes