POST api/GiftCardOps/ChargeGiftCard
ChargeGiftCard removes the specified amount of money from the specified gift card.
Request Information
URI Parameters
None.
Body Parameters
ChargeGiftCardRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID | integer |
None. |
|
| CardNumber | string |
None. |
|
| Amount | decimal number |
None. |
|
| TransactionIdent | integer |
None. |
|
| OnlineTransactionIdent | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ClientID": 1,
"CardNumber": "sample string 2",
"Amount": 3.0,
"TransactionIdent": 4,
"OnlineTransactionIdent": 5
}
application/xml, text/xml
Sample:
<ChargeGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><Amount>3</Amount><CardNumber>sample string 2</CardNumber><ClientID>1</ClientID><OnlineTransactionIdent>5</OnlineTransactionIdent><TransactionIdent>4</TransactionIdent></ChargeGiftCardRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ChargeGiftCardResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| transactionID | integer |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"transactionID": 2,
"ErrorMessage": "sample string 3"
}
application/xml, text/xml
Sample:
<ChargeGiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><ErrorMessage>sample string 3</ErrorMessage><Success>true</Success><transactionID>2</transactionID></ChargeGiftCardResponse>