POST api/GiftCardOps/ClaimGiftCard?transferBalance={transferBalance}

ClaimGiftCard puts a gift card on a Unified customer's account. A charge does not check the claimer, so any holder of the card number can still spend whatever balance stays on the card.

Request Information

URI Parameters

Name	Description	Type	Additional information
transferBalance	Query string. false leaves the balance on the claimed card. Omitted or true moves the whole balance onto the customer's customer card.	boolean	None.

Body Parameters

ClaimGiftCardRequest

Name	Type	Additional information
ClientID	integer	None.
PurchasingOOCustID	integer	None.
EmailAddress	string	None.
Phone	string	None.
FirstName	string	None.
LastName	string	None.
CardNumber	string	None.
ForceClaim	boolean	None.
CustomerCardNumber	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientID": 1,
  "PurchasingOOCustID": 2,
  "EmailAddress": "sample string 3",
  "Phone": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "CardNumber": "sample string 7",
  "ForceClaim": true,
  "CustomerCardNumber": "sample string 8"
}

application/xml, text/xml

Sample:

<ClaimGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><CardNumber>sample string 7</CardNumber><ClientID>1</ClientID><CustomerCardNumber>sample string 8</CustomerCardNumber><EmailAddress>sample string 3</EmailAddress><FirstName>sample string 5</FirstName><ForceClaim>true</ForceClaim><LastName>sample string 6</LastName><Phone>sample string 4</Phone><PurchasingOOCustID>2</PurchasingOOCustID></ClaimGiftCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClaimGiftCardResponse

Name	Type	Additional information
Success	boolean	None.
Balance	decimal number	None.
CustomerMessage	string	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Balance": 2.0,
  "CustomerMessage": "sample string 3",
  "ErrorMessage": "sample string 4"
}

application/xml, text/xml

Sample:

<ClaimGiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><Balance>2</Balance><CustomerMessage>sample string 3</CustomerMessage><ErrorMessage>sample string 4</ErrorMessage><Success>true</Success></ClaimGiftCardResponse>