POST api/GetPaymentReserveId

Returns a payment reserve ID for use with TMS.

Request Information

URI Parameters

None.

Body Parameters

PaymentReserveIdRequest
NameDescriptionTypeAdditional information
Increment

integer

Request Formats

application/json, text/json

Sample:
{
  "Increment": 1
}

application/xml, text/xml

Sample:
<PaymentReserveIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
  <Increment>1</Increment>
</PaymentReserveIdRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PaymentReserveIdRequest'.

Response Information

Resource Description

PaymentReserveIdResponse object

ApiSuccessOfPaymentReserveIdResponse
NameDescriptionTypeAdditional information
Success

boolean
Data

PaymentReserveIdResponse

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "PaymentId": 1
  }
}

application/xml, text/xml

Sample:
<ApiSuccessOfPaymentReserveIdResponseuXxnEBFU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
    <d2p1:PaymentId>1</d2p1:PaymentId>
  </Data>
</ApiSuccessOfPaymentReserveIdResponseuXxnEBFU>