Cart Test
Web/Cart/{sessionKey}/Payments/GiftCertificate
Applies a gift certificate as payment for a cart
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/GiftCertificate

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : ApplyGiftCertificatePaymentRequest

Request object type ApplyGiftCertificatePaymentRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y Amount of the payment. This cannot exceed the balance of the gift certificate. If Amount is specified as 0, the API will determine the correct amount to apply to the order.This amount will be the lesser of the remaining gift certificate amount or the order balance.
GiftCertificateNumber string Y The gift certificate number to use for this payment.
FK: T_GC.gc_no   Resource: GiftCertificates
Notes string 1024 N Optional notes for the payment. 
{
  "Amount": 1.0,
  "GiftCertificateNumber": "sample string 2",
  "Notes": "sample string 3"
}
<ApplyGiftCertificatePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <GiftCertificateNumber>sample string 2</GiftCertificateNumber>
  <Notes>sample string 3</Notes>
</ApplyGiftCertificatePaymentRequest>

Response object type : ApplyPaymentResponse

Response object type ApplyPaymentResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
PaymentId integer 
{
  "PaymentId": 1
}
<ApplyPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentId>1</PaymentId>
</ApplyPaymentResponse>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required