POST api/GiftCardOps/GetTransactionHistory

GetTransactionHistory Links a gift card to a Customer

Request Information

URI Parameters

None.

Body Parameters

GetTransactionHistoryRequest
NameDescriptionTypeAdditional information
ClientID

integer

None.

CardNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": 1,
  "CardNumber": "sample string 2"
}

application/xml, text/xml

Sample:
<GetTransactionHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><CardNumber>sample string 2</CardNumber><ClientID>1</ClientID></GetTransactionHistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetTransactionHistoryResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Balance

decimal number

None.

ErrorMessage

string

None.

Transactions

Collection of TransactionEntry

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Balance": 2.0,
  "ErrorMessage": "sample string 3",
  "Transactions": [
    {
      "TransactionTypeID": 1,
      "TransactionType": "sample string 2",
      "Amount": 3.0,
      "Timestamp": "2025-05-06T09:59:40.0353902+00:00"
    },
    {
      "TransactionTypeID": 1,
      "TransactionType": "sample string 2",
      "Amount": 3.0,
      "Timestamp": "2025-05-06T09:59:40.0353902+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<GetTransactionHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftCardAPI.Models"><Balance>2</Balance><ErrorMessage>sample string 3</ErrorMessage><Success>true</Success><Transactions><TransactionEntry><Amount>3</Amount><Timestamp>2025-05-06T09:59:40.0353902+00:00</Timestamp><TransactionType>sample string 2</TransactionType><TransactionTypeID>1</TransactionTypeID></TransactionEntry><TransactionEntry><Amount>3</Amount><Timestamp>2025-05-06T09:59:40.0353902+00:00</Timestamp><TransactionType>sample string 2</TransactionType><TransactionTypeID>1</TransactionTypeID></TransactionEntry></Transactions></GetTransactionHistoryResponse>