Cancel Member Transaction By Reference Id
1 min
DELETE
https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/transactions/referenceId;{referenceId}
Path Parameters
- memberIdentifierstringrequiredDescriptionMin Length1Max Length200
- referenceIdstringrequiredDescription
Query Parameters
- transactionTypestringDescriptionAllowedBasePartner
Body Parameters
- bodyCancelCallLogDescription
- commentSubReasonstringDescription
- commentsstringDescription
Responses
200
- Transaction[]
- 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
- retailTransactionRetailTransaction
- transactionNbrstringDescription
- pointOfSaleTransNbrstringDescription
- transactionSequenceNbrstringDescription
- storestringDescription
- registerstringDescription
- 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
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
500
curl
curl --request DELETE \
--url https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/transactions/referenceId;{referenceId} \
--header 'accept: application/json'ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/transactions/referenceId;{referenceId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/transactions/referenceId;{referenceId}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/transactions/referenceId;{referenceId}")
.method("DELETE", body)
.addHeader("accept", "application/json")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();200
// Success
[
{
"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
},
"retailTransaction": {
"transactionNbr": "",
"pointOfSaleTransNbr": "",
"transactionSequenceNbr": "",
"store": "",
"register": ""
},
"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": ""
}
]
}
]400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error