Payments Test
TXN/Payments/ReserveIds
Reserves a payment id generated per the request's required "increment" parameter. Increment number must be greater than 0.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/Payments/ReserveIds

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : PaymentReserveIdRequest

Request object type PaymentReserveIdRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Increment integer Y Must be greater than 0. 
{
  "Increment": 1
}
<PaymentReserveIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Increment>1</Increment>
</PaymentReserveIdRequest>

Response object type : PaymentReserveIdResponse

Response object type PaymentReserveIdResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
PaymentId integer 
{
  "PaymentId": 1
}
<PaymentReserveIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentId>1</PaymentId>
</PaymentReserveIdResponse>

No entries in change log for this operation.