POST posSupportAPI/loyalty/closeTransaction

The Loyalty Close Transaction method. This request initiates a Loyalty Close Transaction Event. Clients should make this request to initiate a Loyalty visit or point calculation.

Request Information

URI Parameters

None.

Body Parameters

The Loyalty Close Transaction request context.

LoyaltyCloseTransactionRequest

Name	Description	Type	Additional information
loyaltyNumber	The Loyalty Number of Member .	string	Required
memberUuid	The MemberUuid of loyalty member.	string	Required
redemptionId	The Loyalty Transaction Id.	integer	None.
bill	The loyalty transaction (check) details.	LoyaltyBill	None.

Request Formats

application/json, text/json

Sample:

{
  "loyaltyNumber": "sample string 1",
  "memberUuid": "sample string 2",
  "redemptionId": 3,
  "bill": {
    "checkNumber": 1,
    "server": {
      "id": "sample string 1",
      "fullName": "sample string 2"
    },
    "manager": {
      "id": "sample string 1",
      "fullName": "sample string 2"
    },
    "orderModeId": 1,
    "transactionDateTime": "2025-11-04T13:59:00.2502293-05:00",
    "businessDate": "2025-11-04T13:59:00.2502293-05:00",
    "businessDateTime": "2025-11-04T13:59:00.2502293-05:00",
    "total": 1.0,
    "billLineItems": [
      {
        "itemId": 1,
        "quantity": 1.0,
        "amount": 1.0,
        "itemName": "sample string 1",
        "selected": true,
        "matchedPOS": true,
        "isCombo": true,
        "parentItemId": "sample string 2",
        "sizeId": 1,
        "itemGuid": "sample string 3"
      },
      {
        "itemId": 1,
        "quantity": 1.0,
        "amount": 1.0,
        "itemName": "sample string 1",
        "selected": true,
        "matchedPOS": true,
        "isCombo": true,
        "parentItemId": "sample string 2",
        "sizeId": 1,
        "itemGuid": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<LoyaltyCloseTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <Bill>
    <BillLineItems>
      <BillLineItem>
        <Amount>1</Amount>
        <IsCombo>true</IsCombo>
        <ItemGuid>sample string 3</ItemGuid>
        <ItemId>1</ItemId>
        <ItemName>sample string 1</ItemName>
        <MatchedPOS>true</MatchedPOS>
        <ParentItemId>sample string 2</ParentItemId>
        <Quantity>1</Quantity>
        <Selected>true</Selected>
        <SizeId>1</SizeId>
      </BillLineItem>
      <BillLineItem>
        <Amount>1</Amount>
        <IsCombo>true</IsCombo>
        <ItemGuid>sample string 3</ItemGuid>
        <ItemId>1</ItemId>
        <ItemName>sample string 1</ItemName>
        <MatchedPOS>true</MatchedPOS>
        <ParentItemId>sample string 2</ParentItemId>
        <Quantity>1</Quantity>
        <Selected>true</Selected>
        <SizeId>1</SizeId>
      </BillLineItem>
    </BillLineItems>
    <BusinessDate>2025-11-04T13:59:00.2502293-05:00</BusinessDate>
    <BusinessDateTime>2025-11-04T13:59:00.2502293-05:00</BusinessDateTime>
    <CheckNumber>1</CheckNumber>
    <Manager>
      <FullName>sample string 2</FullName>
      <Id>sample string 1</Id>
    </Manager>
    <OrderModeId>1</OrderModeId>
    <Server>
      <FullName>sample string 2</FullName>
      <Id>sample string 1</Id>
    </Server>
    <Total>1</Total>
    <TransactionDateTime>2025-11-04T13:59:00.2502293-05:00</TransactionDateTime>
  </Bill>
  <LoyaltyNumber>sample string 1</LoyaltyNumber>
  <MemberUuid>sample string 2</MemberUuid>
  <RedemptionId>3</RedemptionId>
</LoyaltyCloseTransactionRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LoyaltyCloseTransactionRequest'.

Response Information

Resource Description

A Loyalty Close Transaction response object.

LoyaltyCloseTransactionResponse

Name	Description	Type	Additional information
pointsEarned	The number of loyalty points earned for the event.	integer	Required
balancePoints	The total points accumulated for the loyalty member.	integer	Required
balanceDollar	The balance dollar accumulated for the loyalty member.	decimal number	Required
result	The result object.	Result	Required

Response Formats

application/json, text/json

Sample:

{
  "pointsEarned": 1,
  "balancePoints": 2,
  "balanceDollar": 3.1,
  "result": {
    "statusCode": 1,
    "description": "sample string 2",
    "exceptionTrackingMoniker": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<LoyaltyCloseTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <BalanceDollar>3.1</BalanceDollar>
  <BalancePoints>2</BalancePoints>
  <PointsEarned>1</PointsEarned>
  <Result>
    <Description>sample string 2</Description>
    <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
    <StatusCode>1</StatusCode>
  </Result>
</LoyaltyCloseTransactionResponse>