GET api/Retail/GetGiftCardBalance?GiftCardID={GiftCardID}&CustomerID={CustomerID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
GiftCardID

string

None.

CustomerID

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of GiftCardBalanceHeader
NameDescriptionTypeAdditional information
GiftCardID

string

None.

CustomerID

string

None.

OpeningDate

date

None.

ValidFromDate

date

None.

ExpirationDate

date

None.

PaymentPuroposeId

string

None.

InitialAmount

decimal number

None.

TotalAmount

decimal number

None.

CardType

string

None.

Response Formats

application/xml, text/xml

Sample:
<ArrayOfGiftCardBalanceHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <GiftCardBalanceHeader>
    <GiftCardID>sample string 1</GiftCardID>
    <CustomerID>sample string 2</CustomerID>
    <OpeningDate>2024-11-21T15:29:22.670792+01:00</OpeningDate>
    <ValidFromDate>2024-11-21T15:29:22.670792+01:00</ValidFromDate>
    <ExpirationDate>2024-11-21T15:29:22.670792+01:00</ExpirationDate>
    <PaymentPuroposeId>sample string 3</PaymentPuroposeId>
    <InitialAmount>4</InitialAmount>
    <TotalAmount>5</TotalAmount>
    <CardType>sample string 6</CardType>
  </GiftCardBalanceHeader>
  <GiftCardBalanceHeader>
    <GiftCardID>sample string 1</GiftCardID>
    <CustomerID>sample string 2</CustomerID>
    <OpeningDate>2024-11-21T15:29:22.670792+01:00</OpeningDate>
    <ValidFromDate>2024-11-21T15:29:22.670792+01:00</ValidFromDate>
    <ExpirationDate>2024-11-21T15:29:22.670792+01:00</ExpirationDate>
    <PaymentPuroposeId>sample string 3</PaymentPuroposeId>
    <InitialAmount>4</InitialAmount>
    <TotalAmount>5</TotalAmount>
    <CardType>sample string 6</CardType>
  </GiftCardBalanceHeader>
</ArrayOfGiftCardBalanceHeader>