GET api/Order/GetGiftCardBalance?giftCardNumber={giftCardNumber}&merchantID={merchantID}&testMode={testMode}

Request Information

URI Parameters

Name	Type	Additional information
giftCardNumber	string	Required
merchantID	string	Required
testMode	boolean	Required

Body Parameters

None.

Response Information

Resource Description

TUSeGiftCardModel

Name	Type	Additional information
balance	decimal number	None.
accountLast4	string	None.
transactionID	string	None.
isSuccessful	boolean	None.
responseCode	integer	None.
responseDetails	Collection of ResponseDetails	None.
amountDetails	AmountDetails	None.
AccountDetails	AccountDetails	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "balance": 1.1,
  "accountLast4": "sample string 2",
  "transactionID": "sample string 3",
  "isSuccessful": true,
  "responseCode": 5,
  "responseDetails": [
    {
      "message": "sample string 1"
    },
    {
      "message": "sample string 1"
    }
  ],
  "amountDetails": {
    "attemptedSubtotalAmount": 1.1,
    "appliedSubtotalAmount": 2.1,
    "attemptedTotalAmount": 3.1,
    "approvedTotalAmount": 4.1
  },
  "AccountDetails": {
    "paymentMethod": 1,
    "cardBin": "sample string 2",
    "paymentAccountLast4": "sample string 3",
    "cardBalanceAmount": 4.1,
    "cardEntryMethod": 5
  }
}

application/xml, text/xml

Sample:

<TUSeGiftCardModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Orders">
  <AccountDetails>
    <cardBalanceAmount>4.1</cardBalanceAmount>
    <cardBin>sample string 2</cardBin>
    <cardEntryMethod>5</cardEntryMethod>
    <paymentAccountLast4>sample string 3</paymentAccountLast4>
    <paymentMethod>1</paymentMethod>
  </AccountDetails>
  <accountLast4>sample string 2</accountLast4>
  <amountDetails>
    <appliedSubtotalAmount>2.1</appliedSubtotalAmount>
    <approvedTotalAmount>4.1</approvedTotalAmount>
    <attemptedSubtotalAmount>1.1</attemptedSubtotalAmount>
    <attemptedTotalAmount>3.1</attemptedTotalAmount>
  </amountDetails>
  <balance>1.1</balance>
  <isSuccessful>true</isSuccessful>
  <responseCode>5</responseCode>
  <responseDetails>
    <ResponseDetails>
      <message>sample string 1</message>
    </ResponseDetails>
    <ResponseDetails>
      <message>sample string 1</message>
    </ResponseDetails>
  </responseDetails>
  <transactionID>sample string 3</transactionID>
</TUSeGiftCardModel>