POST api/GiftCards/Redeem

Request Information

URI Parameters

None.

Body Parameters

EskimoClassLibraries.GiftCardRedeem

Name	Type	Additional information
RedeemAmount	decimal number	Required
CardNumber	string	Required
StoreNumber	string	Required String length: inclusive between 3 and 3

Name

Description

Type

Additional information

RedeemAmount

decimal number

Required

CardNumber

string

Required

StoreNumber

string

Required

String length: inclusive between 3 and 3

Request Formats

application/json, text/json

Sample:

{
  "RedeemAmount": 1.0,
  "CardNumber": "sample string 2",
  "StoreNumber": "sample string 3"
}

application/xml, text/xml

Sample:

<GiftCardRedeem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <CardNumber>sample string 2</CardNumber>
  <StoreNumber>sample string 3</StoreNumber>
  <RedeemAmount>1</RedeemAmount>
</GiftCardRedeem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EskimoClassLibraries.GiftCardResult

Name	Type	Additional information
Successful	boolean	None.
ErrorMessage	string	None.
Serial	string	None.
Balance	decimal number	None.
ExpiryDate	date	None.
TransRef	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Successful": true,
  "ErrorMessage": "sample string 2",
  "Serial": "sample string 3",
  "Balance": 4.0,
  "ExpiryDate": "2024-05-03T08:12:37.3648917+01:00",
  "TransRef": "sample string 6"
}

application/xml, text/xml

Sample:

<GiftCardResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <Balance>4</Balance>
  <ErrorMessage>sample string 2</ErrorMessage>
  <ExpiryDate>2024-05-03T08:12:37.3648917+01:00</ExpiryDate>
  <Serial>sample string 3</Serial>
  <Successful>true</Successful>
  <TransRef>sample string 6</TransRef>
</GiftCardResult>