Cart Test
Web/Cart/{sessionKey}/Payments/Cash
Applies a cash payment to the cart
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/Cash

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : ApplyCashPaymentRequest

Request object type ApplyCashPaymentRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y Amount of the payment.
Notes string 1024 N Optional notes for the payment.
PaymentMethodId integer Y The cash payment method. Must have a payment type of Cash (pmt_type = 5).
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods
TenderedAmount decimal number Y Amount tendered. Must be greater or equal to the Amount. 
{
  "Amount": 1.0,
  "TenderedAmount": 2.0,
  "PaymentMethodId": 3,
  "Notes": "sample string 4"
}
<ApplyCashPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <Notes>sample string 4</Notes>
  <PaymentMethodId>3</PaymentMethodId>
  <TenderedAmount>2</TenderedAmount>
</ApplyCashPaymentRequest>

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