PUT api/me/orders/{orderId}/charge

This method should be used to charge client for a non-appeal related orders

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId	Id of the order 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-20T16:11:33.3830194-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-20T16:11:33.3830194-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-20T16:11:33.3830194-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

TransactionCompletedResponseModel

Name	Type	Additional information
IsSuccess	boolean	None.
ErrorMessage	string	None.
PaidOrdersDetails	Collection of PaidOrderDetailsResponseModel	None.
CompanyId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "errorMessage": "sample string 2",
  "paidOrdersDetails": [
    {
      "paymentDate": "sample string 1",
      "paidAmount": 2.0,
      "isOnetimeCharge": true,
      "isReoccuringCharge": true,
      "status": "sample string 5",
      "orderId": 6,
      "userPropertyId": 1,
      "propertyAddressId": 1,
      "caseId": 1,
      "caseTypeId": 1,
      "formattedPin": "sample string 7",
      "propertyAddress": "sample string 8",
      "productName": "sample string 9",
      "agencyName": "sample string 10",
      "clientName": "sample string 11",
      "clientAddress": "sample string 12",
      "stripeCustomerId": "sample string 13",
      "orderNumber": "sample string 14"
    },
    {
      "paymentDate": "sample string 1",
      "paidAmount": 2.0,
      "isOnetimeCharge": true,
      "isReoccuringCharge": true,
      "status": "sample string 5",
      "orderId": 6,
      "userPropertyId": 1,
      "propertyAddressId": 1,
      "caseId": 1,
      "caseTypeId": 1,
      "formattedPin": "sample string 7",
      "propertyAddress": "sample string 8",
      "productName": "sample string 9",
      "agencyName": "sample string 10",
      "clientName": "sample string 11",
      "clientAddress": "sample string 12",
      "stripeCustomerId": "sample string 13",
      "orderNumber": "sample string 14"
    }
  ],
  "companyId": 3
}

text/html

Sample:

{"isSuccess":true,"errorMessage":"sample string 2","paidOrdersDetails":[{"paymentDate":"sample string 1","paidAmount":2.0,"isOnetimeCharge":true,"isReoccuringCharge":true,"status":"sample string 5","orderId":6,"userPropertyId":1,"propertyAddressId":1,"caseId":1,"caseTypeId":1,"formattedPin":"sample string 7","propertyAddress":"sample string 8","productName":"sample string 9","agencyName":"sample string 10","clientName":"sample string 11","clientAddress":"sample string 12","stripeCustomerId":"sample string 13","orderNumber":"sample string 14"},{"paymentDate":"sample string 1","paidAmount":2.0,"isOnetimeCharge":true,"isReoccuringCharge":true,"status":"sample string 5","orderId":6,"userPropertyId":1,"propertyAddressId":1,"caseId":1,"caseTypeId":1,"formattedPin":"sample string 7","propertyAddress":"sample string 8","productName":"sample string 9","agencyName":"sample string 10","clientName":"sample string 11","clientAddress":"sample string 12","stripeCustomerId":"sample string 13","orderNumber":"sample string 14"}],"companyId":3}

application/xml, text/xml

Sample:

<TransactionCompletedResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.OrderProcessing">
  <CompanyId>3</CompanyId>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccess>true</IsSuccess>
  <PaidOrdersDetails>
    <PaidOrderDetailsResponseModel>
      <AgencyName>sample string 10</AgencyName>
      <CaseId>1</CaseId>
      <CaseTypeId>1</CaseTypeId>
      <ClientAddress>sample string 12</ClientAddress>
      <ClientName>sample string 11</ClientName>
      <FormattedPin>sample string 7</FormattedPin>
      <IsOnetimeCharge>true</IsOnetimeCharge>
      <IsReoccuringCharge>true</IsReoccuringCharge>
      <OrderId>6</OrderId>
      <OrderNumber>sample string 14</OrderNumber>
      <PaidAmount>2</PaidAmount>
      <PaymentDate>sample string 1</PaymentDate>
      <ProductName>sample string 9</ProductName>
      <PropertyAddress>sample string 8</PropertyAddress>
      <PropertyAddressId>1</PropertyAddressId>
      <Status>sample string 5</Status>
      <StripeCustomerId>sample string 13</StripeCustomerId>
      <UserPropertyId>1</UserPropertyId>
    </PaidOrderDetailsResponseModel>
    <PaidOrderDetailsResponseModel>
      <AgencyName>sample string 10</AgencyName>
      <CaseId>1</CaseId>
      <CaseTypeId>1</CaseTypeId>
      <ClientAddress>sample string 12</ClientAddress>
      <ClientName>sample string 11</ClientName>
      <FormattedPin>sample string 7</FormattedPin>
      <IsOnetimeCharge>true</IsOnetimeCharge>
      <IsReoccuringCharge>true</IsReoccuringCharge>
      <OrderId>6</OrderId>
      <OrderNumber>sample string 14</OrderNumber>
      <PaidAmount>2</PaidAmount>
      <PaymentDate>sample string 1</PaymentDate>
      <ProductName>sample string 9</ProductName>
      <PropertyAddress>sample string 8</PropertyAddress>
      <PropertyAddressId>1</PropertyAddressId>
      <Status>sample string 5</Status>
      <StripeCustomerId>sample string 13</StripeCustomerId>
      <UserPropertyId>1</UserPropertyId>
    </PaidOrderDetailsResponseModel>
  </PaidOrdersDetails>
</TransactionCompletedResponseModel>