Cart Test
Web/Cart/{sessionKey}/Payments/OnAccount
Applies an On Account payment to the cart.

Not valid for a general public cart.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/OnAccount

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : ApplyOnAccountPaymentRequest

Request object type ApplyOnAccountPaymentRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number The amount of the payment. This amount cannot exceed the amount of money the constituent has on account for the specified payment method, and cannot cause the total of all payments to exceed the order total.
Notes string 1024 N Optional notes for the payment.
PaymentMethodId integer Y The On-Account payment method. Must have a payment type of on-account (pmt_type = 2).
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods 
{
  "Amount": 1.0,
  "PaymentMethodId": 2,
  "Notes": "sample string 3"
}
<ApplyOnAccountPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <Notes>sample string 3</Notes>
  <PaymentMethodId>2</PaymentMethodId>
</ApplyOnAccountPaymentRequest>

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