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

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : ApplyCheckPaymentRequest

Request object type ApplyCheckPaymentRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y Amount of the payment.
CheckNumber string 30 N Check number, required if the payment method has RequireCheckIndicator true.
Notes string 1024 N Optional notes for the payment.
PayerName string 100 N Check Name.
PaymentMethodId integer Y The check payment method. Must have a payment type of Check (pmt_type = 3).
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods 
{
  "Amount": 1.0,
  "PayerName": "sample string 2",
  "CheckNumber": "sample string 3",
  "PaymentMethodId": 4,
  "Notes": "sample string 5"
}
<ApplyCheckPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <CheckNumber>sample string 3</CheckNumber>
  <Notes>sample string 5</Notes>
  <PayerName>sample string 2</PayerName>
  <PaymentMethodId>4</PaymentMethodId>
</ApplyCheckPaymentRequest>

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