POST posSupportAPI/loyalty/checkRefund

The loyalty reward refund method. The loyalty reward refund request initiates a refund for a previously successfully redeemed reward. The API will validate the transaction and refund as appropriate.

Request Information

URI Parameters

None.

Body Parameters

The loyalty Reward Refund request object.

LoyaltyRefundRequest

Name	Description	Type	Additional information
loyalty	The loyalty details for the transaction (POS Event).	Loyalty	None.
bill	The POS transaction (check) details.	LoyaltyBill	Required
redemptions	The Redemption object Id value for the redemptions that is being voided.	Collection of LoyaltyRedemption	None.

Request Formats

application/json, text/json

Sample:

{
  "loyalty": {
    "loyaltyNumber": "sample string 1",
    "tenantId": 2
  },
  "bill": {
    "checkNumber": 1,
    "server": {
      "id": "sample string 1",
      "fullName": "sample string 2"
    },
    "manager": {
      "id": "sample string 1",
      "fullName": "sample string 2"
    },
    "orderModeId": 1,
    "transactionDateTime": "2024-05-18T00:49:27.3129274-04:00",
    "businessDate": "2024-05-18T00:49:27.3129274-04:00",
    "businessDateTime": "2024-05-18T00:49:27.3129274-04: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
      },
      {
        "itemId": 1,
        "quantity": 1.0,
        "amount": 1.0,
        "itemName": "sample string 1",
        "selected": true,
        "matchedPOS": true,
        "isCombo": true,
        "parentItemId": "sample string 2",
        "sizeId": 1
      }
    ]
  },
  "redemptions": [
    {
      "id": "sample string 1"
    },
    {
      "id": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<LoyaltyRefundRequest 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>
        <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>
        <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>2024-05-18T00:49:27.3129274-04:00</BusinessDate>
    <BusinessDateTime>2024-05-18T00:49:27.3129274-04: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>2024-05-18T00:49:27.3129274-04:00</TransactionDateTime>
  </Bill>
  <Loyalty>
    <LoyaltyNumber>sample string 1</LoyaltyNumber>
    <TenantId>2</TenantId>
  </Loyalty>
  <Redemptions>
    <LoyaltyRedemption>
      <Id>sample string 1</Id>
    </LoyaltyRedemption>
    <LoyaltyRedemption>
      <Id>sample string 1</Id>
    </LoyaltyRedemption>
  </Redemptions>
</LoyaltyRefundRequest>

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 'LoyaltyRefundRequest'.

Response Information

Resource Description

The loyalty refund response object.

LoyaltyRefundResponse

Name	Description	Type	Additional information
successFlag	Indicates if the transaction is success or failure	boolean	None.
message	Transaction Success or Failure summary message	string	None.
statusCode	Indicates the request status. Success = 0 PartialSuccess = 1 Failed = 2	integer	None.
refundDetails	Refund transaction detailed message.	RefundTransactionDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "successFlag": true,
  "message": "sample string 2",
  "statusCode": 3,
  "refundDetails": {
    "loyaltyTransactionResponse": "sample string 1",
    "redemptionVoidResponse": [
      {
        "id": 1,
        "message": "sample string 2"
      },
      {
        "id": 1,
        "message": "sample string 2"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<LoyaltyRefundResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <Message>sample string 2</Message>
  <RefundDetails>
    <LoyaltyTransactionResponse>sample string 1</LoyaltyTransactionResponse>
    <RedemptionVoidResponse>
      <RedemptionVoidResponseMessage>
        <RedemptionId>1</RedemptionId>
        <VoidResponseMessage>sample string 2</VoidResponseMessage>
      </RedemptionVoidResponseMessage>
      <RedemptionVoidResponseMessage>
        <RedemptionId>1</RedemptionId>
        <VoidResponseMessage>sample string 2</VoidResponseMessage>
      </RedemptionVoidResponseMessage>
    </RedemptionVoidResponse>
  </RefundDetails>
  <StatusCode>3</StatusCode>
  <SuccessFlag>true</SuccessFlag>
</LoyaltyRefundResponse>