PUT api/me/userproperties/{userPropertyId}/cases/{caseId}/payments

This method should be used to add a new charge the client for the appeal

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
userPropertyId	Id of the user property record	integer	Required
caseId	Id of the case record	integer	Required

Body Parameters

New charge data

PaymentInfoBindingModel

Name	Type	Additional information
FeeOverride	decimal number	None.
PaymentProviderToken	string	None.
PayeeFirstName	string	Required
PayeeLastName	string	Required
PayeeName	string	None.
StreetAddress	string	None.
City	string	None.
State	string	None.
ZipCode	string	None.
ExpirationMonth	integer	None.
ExpirationYear	integer	None.
IsBillingAddressSimilarToPropertyAddress	boolean	None.
IsCharge	boolean	Required
Method	string	None.
Notes	string	None.
AmountPaid	decimal number	None.
PaymentRecievedDate	date	None.
PropertyAddressId	integer	None.
UserPropertyId	integer	None.
CheckNumber	string	None.

Request Formats

application/json, text/json

Sample:

{
  "feeOverride": 1.0,
  "paymentProviderToken": "sample string 2",
  "payeeFirstName": "sample string 3",
  "payeeLastName": "sample string 4",
  "payeeName": "sample string 5",
  "streetAddress": "sample string 6",
  "city": "sample string 7",
  "state": "sample string 8",
  "zipCode": "sample string 9",
  "expirationMonth": 1,
  "expirationYear": 1,
  "isBillingAddressSimilarToPropertyAddress": true,
  "isCharge": true,
  "method": "sample string 12",
  "notes": "sample string 13",
  "amountPaid": 1.0,
  "paymentRecievedDate": "2025-05-20T15:25:24.1199574-05:00",
  "propertyAddressId": 1,
  "userPropertyId": 1,
  "checkNumber": "sample string 14"
}

text/html

Sample:

{"feeOverride":1.0,"paymentProviderToken":"sample string 2","payeeFirstName":"sample string 3","payeeLastName":"sample string 4","payeeName":"sample string 5","streetAddress":"sample string 6","city":"sample string 7","state":"sample string 8","zipCode":"sample string 9","expirationMonth":1,"expirationYear":1,"isBillingAddressSimilarToPropertyAddress":true,"isCharge":true,"method":"sample string 12","notes":"sample string 13","amountPaid":1.0,"paymentRecievedDate":"2025-05-20T15:25:24.1199574-05:00","propertyAddressId":1,"userPropertyId":1,"checkNumber":"sample string 14"}

application/xml, text/xml

Sample:

<PaymentInfoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.OrderProcessing">
  <AmountPaid>1</AmountPaid>
  <CheckNumber>sample string 14</CheckNumber>
  <City>sample string 7</City>
  <ExpirationMonth>1</ExpirationMonth>
  <ExpirationYear>1</ExpirationYear>
  <FeeOverride>1</FeeOverride>
  <IsBillingAddressSimilarToPropertyAddress>true</IsBillingAddressSimilarToPropertyAddress>
  <IsCharge>true</IsCharge>
  <Method>sample string 12</Method>
  <Notes>sample string 13</Notes>
  <PayeeFirstName>sample string 3</PayeeFirstName>
  <PayeeLastName>sample string 4</PayeeLastName>
  <PayeeName>sample string 5</PayeeName>
  <PaymentProviderToken>sample string 2</PaymentProviderToken>
  <PaymentRecievedDate>2025-05-20T15:25:24.1199574-05:00</PaymentRecievedDate>
  <PropertyAddressId>1</PropertyAddressId>
  <State>sample string 8</State>
  <StreetAddress>sample string 6</StreetAddress>
  <UserPropertyId>1</UserPropertyId>
  <ZipCode>sample string 9</ZipCode>
</PaymentInfoBindingModel>

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 'PaymentInfoBindingModel'.

Response Information

Resource Description

TransactionCompletedCaseResponseModel

Name	Type	Additional information
IsSuccess	boolean	None.
ErrorMessage	string	None.
Cases	Collection of PaidCaseDetailModel	None.
IsCaseOrder	boolean	None.
OrderId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "errorMessage": "sample string 2",
  "cases": [
    {
      "caseId": 1,
      "userPropertyId": 1,
      "caseTypeId": 2,
      "companyId": 3
    },
    {
      "caseId": 1,
      "userPropertyId": 1,
      "caseTypeId": 2,
      "companyId": 3
    }
  ],
  "isCaseOrder": true,
  "orderId": 4
}

text/html

Sample:

{"isSuccess":true,"errorMessage":"sample string 2","cases":[{"caseId":1,"userPropertyId":1,"caseTypeId":2,"companyId":3},{"caseId":1,"userPropertyId":1,"caseTypeId":2,"companyId":3}],"isCaseOrder":true,"orderId":4}

application/xml, text/xml

Sample:

<TransactionCompletedCaseResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.CaseBinding">
  <Cases>
    <PaidCaseDetailModel>
      <CaseId>1</CaseId>
      <CaseTypeId>2</CaseTypeId>
      <CompanyId>3</CompanyId>
      <UserPropertyId>1</UserPropertyId>
    </PaidCaseDetailModel>
    <PaidCaseDetailModel>
      <CaseId>1</CaseId>
      <CaseTypeId>2</CaseTypeId>
      <CompanyId>3</CompanyId>
      <UserPropertyId>1</UserPropertyId>
    </PaidCaseDetailModel>
  </Cases>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsCaseOrder>true</IsCaseOrder>
  <IsSuccess>true</IsSuccess>
  <OrderId>4</OrderId>
</TransactionCompletedCaseResponseModel>