Skip to main content
POST
/
lbms-ingress
/
pg-lm
/
API
/
PG
/
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
}
'
{
  "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

ValueCategory
4Miles / Points Transfer
5Hotel
6Air / Flight
19Charity
30Gift 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

PathTypeDescription
results.IsSucessfulbooleantrue
results.ErrorCodestring000
results.ExceptionMessagestringSuccess
results.ReturnObjectstring (UUID)ExternalReference for this transaction. Store for potential reversal.

​
Error Codes

CodeExceptionMessageCause
000SuccessPoints deducted; redemption details in the response
103Member does not existRelationReference not found in the program
107Member status is not ActiveMember has not been activated
113Member is cancelledMember account is cancelled
114Member is suspendedMember account is suspended
120Points must be greater than zeroPoints value is 0 or negative
208Merchant name missingMerchantName not provided in the request
301Failed to redeem pointsRedemption operation failed
302Insufficient pointsPoints requested exceed the member’s available balance
997Exception occurredUnexpected server-side error
999Bad requestMalformed 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