Cart Test
Web/Cart/{sessionKey}/Payments/Invoice
Applies an invoice payment to the cart

Checkout will not be allowed for a general public order if an Invoice payment is applied
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/Invoice

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : ApplyInvoicePaymentRequest

Request object type ApplyInvoicePaymentRequest 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 invoice payment method. Must have a payment type of invoice (pmt_type = 4).
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods 
{
  "Amount": 1.0,
  "PaymentMethodId": 2,
  "Notes": "sample string 3"
}
<ApplyInvoicePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <Notes>sample string 3</Notes>
  <PaymentMethodId>2</PaymentMethodId>
</ApplyInvoicePaymentRequest>

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