Create Member Redemption
1 min
POST
https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/redemptions
Path Parameters
- memberIdentifierstringrequiredDescriptionMin Length1Max Length200
Query Parameters
- createCouponUsebooleanDescriptionDefaultfalse
- holdCouponbooleanDescriptionDefaultfalse
- validateOnlybooleanDescriptionDefaultfalse
- allowOverRedeembooleanDescriptionDefaultfalse
- allowPoolRedeembooleanDescriptionDefaultfalse
- migratebooleanDescriptionDefaultfalse
- skipFraudCheckbooleanDescriptionDefaultfalse
- asyncbooleanDescriptionDefaultfalse
Body Parameters
- bodyMemberRedemptionRequestDescription
- redemptionItemCodestringDescription
- redemptionDatestring<date>ExampleDescriptionFormatdate
- referenceIdstringDescription
- quantityinteger<int32>requiredDescriptionFormatint32Minimum1
- providedAmountnumberExampleDescription
- transactionAmountnumberExampleDescription
- externalCodestringDescription
- offerCriteriamap<string, string>Description
- orderAddressMemberRedemptionOrderAddress
- namestringDescriptionMin Length0Max Length128
- address1stringrequiredDescriptionMin Length0Max Length128
- address2stringDescriptionMin Length0Max Length128
- address3stringDescriptionMin Length0Max Length100
- citystringrequiredDescriptionMin Length0Max Length128
- stateCodestringrequiredDescription
- zipstringrequiredDescriptionMin Length0Max Length20
- countryCodestringrequiredDescription
- emailAddressstringDescriptionMin Length0Max Length150
- phoneNumberstringDescriptionMin Length0Max Length128
- couponUseCouponUseRequest
- useDateTimestring<date-time>DescriptionFormatdate-time
- aliasstringDescriptionMin Length0Max Length50
- useCountinteger<int32>ExampleDescriptionFormatint32
- messageFromGiftingMemberstringDescriptionMin Length0Max Length255
- validationAttributesmap<string, string>Description
- reportingAttributesmap<string, string>Description
- attributesmap<string, string>Description
- lineItemsMemberRedemptionLineItem[]Description
- descriptionstringDescription
- itemCodestringDescription
- quantityinteger<int32>DescriptionFormatint32
- amountnumberDescriptionMinimum1
- statusstringDescription
- expectedShipDatestring<date>ExampleDescriptionFormatdate
- invoiceNumberstringDescription
Responses
200
- MemberRedemption
- memberRedemptionIdobjectExampleDescription
- memberIdentifierstringDescriptionMin Length1Max Length200
- redemptionItemCodestringExampleDescription
- redemptionItemDescriptionstringExampleDescription
- referenceIdstringExampleDescription
- redemptionDatestring<date>ExampleDescriptionFormatdate
- customDataCustomData
- ace01stringDescription
- ace01DescriptionstringDescription
- ace02stringDescription
- ace02DescriptionstringDescription
- ace03stringDescription
- ace03DescriptionstringDescription
- ace04stringDescription
- ace04DescriptionstringDescription
- ace05stringDescription
- ace05DescriptionstringDescription
- ace06stringDescription
- ace06DescriptionstringDescription
- ace07stringDescription
- ace07DescriptionstringDescription
- ace08stringDescription
- ace08DescriptionstringDescription
- ace09stringDescription
- ace09DescriptionstringDescription
- ace10stringDescription
- ace10DescriptionstringDescription
- ace11stringDescription
- ace11DescriptionstringDescription
- ace12stringDescription
- ace12DescriptionstringDescription
- ace13stringDescription
- ace13DescriptionstringDescription
- ace14stringDescription
- ace14DescriptionstringDescription
- ace15stringDescription
- ace15DescriptionstringDescription
- quantityinteger<int32>ExampleDescriptionFormatint32
- currencyValuenumberExampleDescription
- partnerCodestringExampleDescription
- expectedShipDatestring<date>ExampleDescriptionFormatdate
- orderAddressMemberRedemptionOrderAddress
- namestringDescriptionMin Length0Max Length128
- address1stringrequiredDescriptionMin Length0Max Length128
- address2stringDescriptionMin Length0Max Length128
- address3stringDescriptionMin Length0Max Length100
- citystringrequiredDescriptionMin Length0Max Length128
- stateCodestringrequiredDescription
- zipstringrequiredDescriptionMin Length0Max Length20
- countryCodestringrequiredDescription
- emailAddressstringDescriptionMin Length0Max Length150
- phoneNumberstringDescriptionMin Length0Max Length128
- bonusesTransaction[]Description
- transactionIdstringDescription
- transactionGroupIdstringDescription
- transactionGroupReferenceIdstringDescription
- parentTransactionIdstringDescription
- linkedTransactionIdstringDescription
- referenceIdstringDescription
- memberIdentifierstringDescriptionMin Length1Max Length200
- accountNumberstringDescriptionMin Length7Max Length25
- memberRedemptionIdstringExampleDescription
- transactionDateTimestring<date-time>DescriptionFormatdate-time
- partnerNamestringDescription
- partnerProgramCodestringDescription
- descriptionstringDescriptionMax Length250
- typeCodestringDescriptionMax Length50
- typeDescriptionstringDescription
- subTypeCodestringDescriptionMax Length50
- postDatestring<date>DescriptionFormatdate
- originationDatestring<date>DescriptionFormatdate
- retrobooleanDescription
- editedbooleanDescription
- sourceCodestringDescription
- statusCodestringDescription
- updateDateTimestring<date-time>DescriptionFormatdate-time
- earningRuleDescriptionstringDescription
- customDataCustomData
- ace01stringDescription
- ace01DescriptionstringDescription
- ace02stringDescription
- ace02DescriptionstringDescription
- ace03stringDescription
- ace03DescriptionstringDescription
- ace04stringDescription
- ace04DescriptionstringDescription
- ace05stringDescription
- ace05DescriptionstringDescription
- ace06stringDescription
- ace06DescriptionstringDescription
- ace07stringDescription
- ace07DescriptionstringDescription
- ace08stringDescription
- ace08DescriptionstringDescription
- ace09stringDescription
- ace09DescriptionstringDescription
- ace10stringDescription
- ace10DescriptionstringDescription
- ace11stringDescription
- ace11DescriptionstringDescription
- ace12stringDescription
- ace12DescriptionstringDescription
- ace13stringDescription
- ace13DescriptionstringDescription
- ace14stringDescription
- ace14DescriptionstringDescription
- ace15stringDescription
- ace15DescriptionstringDescription
- spendTransactionSpend
- perItemnumberDescriptionMinimum0Maximum9999999999.99
- spendAmountnumberDescriptionMinimum0Maximum9999999999.99
- currencyTypeCodestringDescriptionMin Length0Max Length50
- currencyCategoryCodestringDescriptionMin Length0Max Length50
- isoCurrencyCodestringDescriptionMin Length0Max Length3
- currencyConversionRationumber<double>DescriptionFormatdouble
- quantityinteger<int32>DescriptionFormatint32Minimum0Maximum999999999
- earnTransactionEarn
- amountnumberrequiredDescriptionMinimum0.01Maximum9999999999.99
- currencyTypeCodestringDescriptionMin Length0Max Length50
- currencyCategoryCodestringDescriptionMin Length0Max Length10
- earningsLimitedbooleanDescriptionDefaultfalse
- tierQualifyingbooleanDescription
- transactionCountersCounter[]Description
- counterTypeCodestringDescription
- counterValuenumberDescription
- redemptionTransactionRedemption
- redemptionItemCodestringDescription
- currencyRequirednumberDescription
- minimumQuantityinteger<int32>DescriptionFormatint32
- maximumQuantityinteger<int32>DescriptionFormatint32
- redeemIncrementinteger<int32>DescriptionFormatint32
- faceValuenumberDescription
- amountProvidedbooleanDescription
- poolNamestringExampleDescriptionMax Length128
- lineItemsMemberRedemptionLineItem[]Description
- descriptionstringDescription
- itemCodestringDescription
- quantityinteger<int32>DescriptionFormatint32
- amountnumberDescriptionMinimum1
- expiredCurrencyTransactionExpiredCurrency
- expiredAmountnumberrequiredDescription
- expiredDatestring<date>DescriptionFormatdate
- currencyTypeCodestringDescriptionMin Length0Max Length50
- currencyCategoryCodestringDescriptionMin Length0Max Length50
- hotelTransactionHotelTransaction
- checkInDatestring<date>DescriptionFormatdate
- checkOutDatestring<date>DescriptionFormatdate
- eligibleStaysinteger<int32>DescriptionFormatint32
- eligibleCappedNightsinteger<int32>DescriptionFormatint32
- eligibleNightsinteger<int32>DescriptionFormatint32
- roomNumberstringDescription
- roomTypestringDescription
- roomRatenumberDescription
- roomRateIntlnumberDescription
- totalRevenueAmountnumberDescription
- totalRevenueAmountIntlnumberDescription
- loyaltyEligibleAmountnumberDescription
- loyaltyEligibleAmountIntlnumberDescription
- loyaltyIneligibleAmountnumberDescription
- loyaltyIneligibleAmountIntlnumberDescription
- isoCurrencyCodestringDescription
- bookingSourcestringDescription
- paymentCodestringDescription
- purposeOfVisitstringDescription
- travelAgentNamestringDescription
- groupNamestringDescription
- companyNamestringDescription
- reservationConfirmationNumberstringDescription
- noShowbooleanDescription
- pmsConfirmationNumberstringDescription
- overlappingStayPoolIdstringDescription
- nonStayIndicatorbooleanDescription
- nonStayLocationIdstringDescription
- nonStayEligibleRevenuenumberDescription
- nonStayEligibleRevenueIntlnumberDescription
- nonStayIneligibleRevenuenumberDescription
- nonStayIneligibleRevenueIntlnumberDescription
- checkNumberstringDescription
- travelTransactionTravelTransaction
- activityStartDateTimestring<date-time>DescriptionFormatdate-time
- activityEndDateTimestring<date-time>DescriptionFormatdate-time
- totalSpendAmountnumberDescriptionMinimum0Maximum9999999999.99
- transactionReferencemap<string, object>Description
- cancelablebooleanDescription
- editablebooleanDescription
- createUserIdinteger<int64>DescriptionFormatint64
- createUserNamestringDescription
- updateUserIdinteger<int64>DescriptionFormatint64
- updateUserNamestringDescription
- memberCommentIdinteger<int64>DescriptionFormatint64
- cancellationSubReasonstringDescription
- businessEligiblebooleanDescription
- businessAccountNumberstringDescription
- awardNumberstringDescription
- baseAccountNumberstringDescription
- transactionAdjustmentTransactionAdjustment
- commentsstringDescription
- referenceIdstringDescription
- reasonCodestringDescription
- transactionBonusTransactionBonus
- bonusCodestringDescription
- bonusTypestringDescription
- transactionPartnerTransactionPartner
- partnerNamestringDescription
- partnerCurrencyCategoryCodestringDescription
- transactionPromotionTransactionPromotion
- promotionCodestringDescription
- transactionTransferTransactionTransfer
- fromMemberAccountNumberstringExampleDescription
- fromMemberNamestringExampleDescription
- toMemberAccountNumberstringExampleDescription
- toMemberNamestringExampleDescription
- transferredBystringExampleDescriptionMax Length25
- mergeDetailsMergeDetail
- fromMemberAccountNumberstringExampleDescription
- transactionRelationshipsTransactionRelationship[]
- typestring<B2B_PREDECESSOR | B2B_SUCCESSOR | CLONE_SOURCE | CLONE_TARGET | POOL_REDEMPTION_CONTRIBUTION | POOL_REDEMPTION_SOURCE>ExampleDescriptionAllowedB2B_PREDECESSORB2B_SUCCESSORCLONE_SOURCECLONE_TARGETPOOL_REDEMPTION_CONTRIBUTIONPOOL_REDEMPTION_SOURCE
- keystringExampleDescription
- accountNumberstringDescription
- couponsMemberCoupon[]Description
- memberCouponIdinteger<int64>ExampleDescriptionFormatint64
- memberIdentifierstringDescriptionMin Length1Max Length200
- couponCouponrequired
- couponIdinteger<int64>ExampleDescriptionFormatint64
- couponRequestIdinteger<int64>ExampleDescriptionFormatint64
- offerOfferDescription
- offerIdinteger<int64>ExampleDescriptionFormatint64
- offerTypeCodestringrequiredExampleDescription
- codestringExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- featureVersioninteger<int32>ExampleDescriptionFormatint32
- statusCodestringrequiredExampleDescription
- startDateTimestring<date-time>DescriptionFormatdate-time
- endDateTimestring<date-time>DescriptionFormatdate-time
- offerAttributesOfferAttribute[]Description
- offerAttributeIdinteger<int64>ExampleDescriptionFormatint64
- attributeAttributerequired
- attributeIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- statusCodestringrequiredExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- dataTypeCodestringrequiredExampleDescription
- defaultValuestringExampleDescription
- requireOnUsebooleanExampleDescription
- requireOnHoldbooleanExampleDescription
- includeOnResponsebooleanDescription
- attributeTypeCodestringExampleDescription
- operatorCodestringExampleDescription
- operandstringExampleDescription
- smartGroupIdinteger<int64>ExampleDescriptionFormatint64
- codestringExampleDescription
- statusCodestringExampleDescription
- startDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- useTypeCodestringExampleDescriptionDefaultSingle
- useLimitinteger<int32>ExampleDescriptionDefault1Formatint32
- currentUseinteger<int32>ExampleDescriptionFormatint32
- couponUsesCouponUse[]Description
- useDateTimestring<date-time>DescriptionFormatdate-time
- statusCodestringrequiredExampleDescription
- channelCodestringrequiredExampleDescription
- aliasstringDescription
- useCountinteger<int32>requiredExampleDescriptionFormatint32
- couponUseAttributesCouponUseAttribute[]Description
- couponUseAttributeIdinteger<int64>ExampleDescriptionFormatint64
- attributeAttributerequired
- attributeIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- statusCodestringrequiredExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- dataTypeCodestringrequiredExampleDescription
- valuestringExampleDescription
- couponAttributesCouponAttribute[]Description
- couponAttributeIdinteger<int64>ExampleDescriptionFormatint64
- attributeAttributerequired
- attributeIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- statusCodestringrequiredExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- dataTypeCodestringrequiredExampleDescription
- valuestringExampleDescription
- requireOnUsebooleanExampleDescription
- requireOnHoldbooleanDescription
- sourceTypeCodestringrequiredExampleDescription
- sourceReferenceRuleCodestringExampleDescription
- sourceReferenceIdinteger<int64>requiredExampleDescriptionFormatint64
- aggregateStatusCodestringExampleDescription
- statusCodestringrequiredExampleDescription
- transferablebooleanDescription
- previouslyTransferredbooleanDescription
- relatedRedemptionIdinteger<int64>ExampleDescriptionFormatint64
- fraudRiskScorenumberExampleDescriptionMinimum0Maximum100
- fraudConfirmationbooleanDescription
- statusstringDescription
- redemptionRuleCodestringDescription
- transactionAmountnumberDescription
- invoiceNumberstringDescription
- lineItemsMemberRedemptionLineItem[]Description
- descriptionstringDescription
- itemCodestringDescription
- quantityinteger<int32>DescriptionFormatint32
- amountnumberDescriptionMinimum1
- poolFundingRedemptionPoolContribution[]Description
- memberIdentifierstringExampleDescription
- contributionAmountnumberExampleDescription
- poolCancellationsRedemptionPoolContribution[]Description
- memberIdentifierstringExampleDescription
- contributionAmountnumberExampleDescription
202
- AsyncTask
- asyncTaskIdinteger<int64>Formatint64
- taskTypeCodestringExampleDescription
- taskCodestringExampleDescription
- requestDatestring<date-time>DescriptionFormatdate-time
- requestDataobjectDescription
- statusCodestringDescription
- responseDatestring<date-time>DescriptionFormatdate-time
- responseDataobjectDescription
- fileNamestringDescription
- lineNumberintegerDescription
- fileDatastringDescription
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
500
curl
curl --request POST \
--url 'https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/redemptions?createCouponUse=boolean&holdCoupon=boolean&validateOnly=boolean&allowOverRedeem=boolean&allowPoolRedeem=boolean&migrate=boolean&skipFraudCheck=boolean&async=boolean' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"quantity": "",
"orderAddress": {
"address1": "",
"city": "",
"stateCode": "",
"zip": "",
"countryCode": ""
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"quantity": "",
"orderAddress": {
"address1": "",
"city": "",
"stateCode": "",
"zip": "",
"countryCode": ""
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/redemptions?createCouponUse=boolean&holdCoupon=boolean&validateOnly=boolean&allowOverRedeem=boolean&allowPoolRedeem=boolean&migrate=boolean&skipFraudCheck=boolean&async=boolean", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/redemptions?createCouponUse=boolean&holdCoupon=boolean&validateOnly=boolean&allowOverRedeem=boolean&allowPoolRedeem=boolean&migrate=boolean&skipFraudCheck=boolean&async=boolean")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"quantity": "",
"orderAddress": {
"address1": "",
"city": "",
"stateCode": "",
"zip": "",
"countryCode": ""
}
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/redemptions?createCouponUse=boolean&holdCoupon=boolean&validateOnly=boolean&allowOverRedeem=boolean&allowPoolRedeem=boolean&migrate=boolean&skipFraudCheck=boolean&async=boolean"
payload = json.dumps({
"quantity": "",
"orderAddress": {
"address1": "",
"city": "",
"stateCode": "",
"zip": "",
"countryCode": ""
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success
{
"memberRedemptionId": {},
"memberIdentifier": "",
"redemptionItemCode": "GIFT-CARD-50",
"redemptionItemDescription": "50$ Gift Card",
"referenceId": 12345,
"redemptionDate": "2020-01-01",
"customData": {
"ace01": "",
"ace01Description": "",
"ace02": "",
"ace02Description": "",
"ace03": "",
"ace03Description": "",
"ace04": "",
"ace04Description": "",
"ace05": "",
"ace05Description": "",
"ace06": "",
"ace06Description": "",
"ace07": "",
"ace07Description": "",
"ace08": "",
"ace08Description": "",
"ace09": "",
"ace09Description": "",
"ace10": "",
"ace10Description": "",
"ace11": "",
"ace11Description": "",
"ace12": "",
"ace12Description": "",
"ace13": "",
"ace13Description": "",
"ace14": "",
"ace14Description": "",
"ace15": "",
"ace15Description": ""
},
"quantity": 10,
"currencyValue": 100,
"partnerCode": "PARTNER123",
"expectedShipDate": "2020-01-01",
"orderAddress": {
"name": "",
"address1": "",
"address2": "",
"address3": "",
"city": "",
"stateCode": "",
"zip": "",
"countryCode": "",
"emailAddress": "",
"phoneNumber": ""
},
"bonuses": [
{
"transactionId": "",
"transactionGroupId": "",
"transactionGroupReferenceId": "",
"parentTransactionId": "",
"linkedTransactionId": "",
"referenceId": "",
"memberIdentifier": "",
"accountNumber": "",
"memberRedemptionId": "1",
"transactionDateTime": "",
"partnerName": "",
"partnerProgramCode": "",
"description": "",
"typeCode": "",
"typeDescription": "",
"subTypeCode": "",
"postDate": "",
"originationDate": "",
"retro": false,
"edited": false,
"sourceCode": "",
"statusCode": "",
"updateDateTime": "",
"earningRuleDescription": "",
"customData": {
"ace01": "",
"ace01Description": "",
"ace02": "",
"ace02Description": "",
"ace03": "",
"ace03Description": "",
"ace04": "",
"ace04Description": "",
"ace05": "",
"ace05Description": "",
"ace06": "",
"ace06Description": "",
"ace07": "",
"ace07Description": "",
"ace08": "",
"ace08Description": "",
"ace09": "",
"ace09Description": "",
"ace10": "",
"ace10Description": "",
"ace11": "",
"ace11Description": "",
"ace12": "",
"ace12Description": "",
"ace13": "",
"ace13Description": "",
"ace14": "",
"ace14Description": "",
"ace15": "",
"ace15Description": ""
},
"spend": {
"perItem": 0,
"spendAmount": 0,
"currencyTypeCode": "",
"currencyCategoryCode": "",
"isoCurrencyCode": "",
"currencyConversionRatio": "",
"quantity": ""
},
"earn": {
"amount": 0,
"currencyTypeCode": "",
"currencyCategoryCode": "",
"earningsLimited": false,
"tierQualifying": false,
"transactionCounters": [
{
"counterTypeCode": "",
"counterValue": 0
}
]
},
"redemption": {
"redemptionItemCode": "",
"currencyRequired": 0,
"minimumQuantity": "",
"maximumQuantity": "",
"redeemIncrement": "",
"faceValue": 0,
"amountProvided": false,
"poolName": "PL-16",
"lineItems": [
{
"description": "",
"itemCode": "",
"quantity": "",
"amount": 0
}
]
},
"expiredCurrency": {
"expiredAmount": 0,
"expiredDate": "",
"currencyTypeCode": "",
"currencyCategoryCode": ""
},
"hotelTransaction": {
"checkInDate": "",
"checkOutDate": "",
"eligibleStays": "",
"eligibleCappedNights": "",
"eligibleNights": "",
"roomNumber": "",
"roomType": "",
"roomRate": 0,
"roomRateIntl": 0,
"totalRevenueAmount": 0,
"totalRevenueAmountIntl": 0,
"loyaltyEligibleAmount": 0,
"loyaltyEligibleAmountIntl": 0,
"loyaltyIneligibleAmount": 0,
"loyaltyIneligibleAmountIntl": 0,
"isoCurrencyCode": "",
"bookingSource": "",
"paymentCode": "",
"purposeOfVisit": "",
"travelAgentName": "",
"groupName": "",
"companyName": "",
"reservationConfirmationNumber": "",
"noShow": false,
"pmsConfirmationNumber": "",
"overlappingStayPoolId": "",
"nonStayIndicator": false,
"nonStayLocationId": "",
"nonStayEligibleRevenue": 0,
"nonStayEligibleRevenueIntl": 0,
"nonStayIneligibleRevenue": 0,
"nonStayIneligibleRevenueIntl": 0,
"checkNumber": ""
},
"travelTransaction": {
"activityStartDateTime": "",
"activityEndDateTime": "",
"totalSpendAmount": 0
},
"transactionReference": "",
"cancelable": false,
"editable": false,
"createUserId": "",
"createUserName": "",
"updateUserId": "",
"updateUserName": "",
"memberCommentId": "",
"cancellationSubReason": "",
"businessEligible": false,
"businessAccountNumber": "",
"awardNumber": "",
"baseAccountNumber": "",
"transactionAdjustment": {
"comments": "",
"referenceId": "",
"reasonCode": ""
},
"transactionBonus": {
"bonusCode": "",
"bonusType": ""
},
"transactionPartner": {
"partnerName": "",
"partnerCurrencyCategoryCode": ""
},
"transactionPromotion": {
"promotionCode": ""
},
"transactionTransfer": {
"fromMemberAccountNumber": "A234567890",
"fromMemberName": "Marcel Rufus",
"toMemberAccountNumber": "B987654321",
"toMemberName": "Janel Liesje",
"transferredBy": "A0123456789"
},
"mergeDetails": {
"fromMemberAccountNumber": "A234567890"
},
"transactionRelationships": [
{
"type": "B2B_SUCCESSOR",
"key": "EB-1234",
"accountNumber": ""
}
]
}
],
"coupons": [
{
"memberCouponId": 147258369,
"memberIdentifier": "",
"coupon": {
"couponId": 147258369,
"couponRequestId": 147258370,
"offer": {
"offerId": 147258369,
"offerTypeCode": "Discount",
"code": "ALON2020",
"name": "Free night",
"description": "Award double points",
"featureVersion": 2,
"statusCode": "Enabled",
"startDateTime": "",
"endDateTime": "",
"offerAttributes": [
{
"offerAttributeId": 147258369,
"attribute": {
"attributeId": 147258369,
"typeCode": "Validation",
"statusCode": "Enabled",
"name": "AccountNumber",
"description": "Account Number",
"dataTypeCode": "open"
},
"defaultValue": "Standard",
"requireOnUse": true,
"requireOnHold": true,
"includeOnResponse": false,
"attributeTypeCode": "Validation",
"operatorCode": "EQ",
"operand": "GI",
"smartGroupId": 147258369
}
]
},
"code": "ZPVWTAROW2OQ",
"statusCode": "Activated",
"startDate": "",
"endDate": "",
"useTypeCode": "Single",
"useLimit": 1,
"currentUse": 1,
"couponUses": [
{
"useDateTime": "",
"statusCode": "Used",
"channelCode": "System",
"alias": "",
"useCount": 1,
"couponUseAttributes": [
{
"couponUseAttributeId": 147258369,
"attribute": {
"attributeId": 147258369,
"typeCode": "Validation",
"statusCode": "Enabled",
"name": "AccountNumber",
"description": "Account Number",
"dataTypeCode": "open"
},
"value": "Standard"
}
]
}
],
"couponAttributes": [
{
"couponAttributeId": 147258369,
"attribute": {
"attributeId": 147258369,
"typeCode": "Validation",
"statusCode": "Enabled",
"name": "AccountNumber",
"description": "Account Number",
"dataTypeCode": "open"
},
"value": "2021-12-31T12:00:00",
"requireOnUse": true,
"requireOnHold": false
}
]
},
"sourceTypeCode": "Promotion",
"sourceReferenceRuleCode": "StayBonus",
"sourceReferenceId": 147258369,
"aggregateStatusCode": "Active",
"statusCode": "Active",
"transferable": false,
"previouslyTransferred": false
}
],
"relatedRedemptionId": 12342328,
"fraudRiskScore": 25.75,
"fraudConfirmation": false,
"status": "",
"redemptionRuleCode": "",
"transactionAmount": 0,
"invoiceNumber": "",
"lineItems": [
{
"description": "",
"itemCode": "",
"quantity": "",
"amount": 0
}
],
"poolFunding": [
{
"memberIdentifier": 123456789,
"contributionAmount": 375
}
],
"poolCancellations": [
{
"memberIdentifier": 123456789,
"contributionAmount": 375
}
]
}202
// Accepted
{
"asyncTaskId": "",
"taskTypeCode": "PlatformAPI",
"taskCode": "enrollMember",
"requestDate": "",
"requestData": {},
"statusCode": "",
"responseDate": "",
"responseData": {},
"fileName": "",
"lineNumber": 0,
"fileData": ""
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error