GiftCertificates Test
Finance/GiftCertificates/TransactionDetailsForRedemption
Get transaction details for a gift certificate and lock it for redemption in a specific batch.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/GiftCertificates/TransactionDetailsForRedemption

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : GiftCertificateRedemptionRequest

Request object type GiftCertificateRedemptionRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
BatchId integer
LockForBatch boolean
Number string
PaymentMethodId integer 
{
  "Number": "sample string 1",
  "BatchId": 1,
  "LockForBatch": true,
  "PaymentMethodId": 1
}
<GiftCertificateRedemptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BatchId>1</BatchId>
  <LockForBatch>true</LockForBatch>
  <Number>sample string 1</Number>
  <PaymentMethodId>1</PaymentMethodId>
</GiftCertificateRedemptionRequest>

Response object type : Collection of GiftCertificateTransaction

Response object type Collection of GiftCertificateTransaction has the following properties.
Property Name Data Type Length Required Readonly Notes
Action string
Amount decimal number
PaymentId integer
TransactionDate date 
[
  {
    "Action": "sample string 1",
    "Amount": 2.0,
    "TransactionDate": "2025-04-24T05:05:38.6709662-07:00",
    "PaymentId": 4
  },
  {
    "Action": "sample string 1",
    "Amount": 2.0,
    "TransactionDate": "2025-04-24T05:05:38.6709662-07:00",
    "PaymentId": 4
  }
]
<GiftCertificateTransactions xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <GiftCertificateTransaction>
    <Action>sample string 1</Action>
    <Amount>2</Amount>
    <PaymentId>4</PaymentId>
    <TransactionDate>2025-04-24T05:05:38.6709662-07:00</TransactionDate>
  </GiftCertificateTransaction>
  <GiftCertificateTransaction>
    <Action>sample string 1</Action>
    <Amount>2</Amount>
    <PaymentId>4</PaymentId>
    <TransactionDate>2025-04-24T05:05:38.6709662-07:00</TransactionDate>
  </GiftCertificateTransaction>
</GiftCertificateTransactions>

No entries in change log for this operation.