POST api/web/client/{clientId}/user/{userId}/charge

Use this method to charge credit card of the site visitor for analysis fee prior to allowing the user to view Property Tax Analysis results

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Attorney user system record id	integer	Required
userId	Web user system record id	integer	Required

Body Parameters

WebUserPaymentBindingModel

Name	Type	Additional information
PayeeFirstName	string	Required
PayeeLastName	string	Required
ExpirationMonth	integer	Required
ExpirationYear	integer	Required
AmountBilled	decimal number	Required
PaymentProviderToken	string	Required
CartId	integer	Required
ZipCode	string	Required

Request Formats

application/json, text/json

Sample:

{
  "payeeFirstName": "sample string 1",
  "payeeLastName": "sample string 2",
  "expirationMonth": 3,
  "expirationYear": 4,
  "amountBilled": 5.0,
  "paymentProviderToken": "sample string 6",
  "cartId": 7,
  "zipCode": "sample string 8"
}

text/html

Sample:

{"payeeFirstName":"sample string 1","payeeLastName":"sample string 2","expirationMonth":3,"expirationYear":4,"amountBilled":5.0,"paymentProviderToken":"sample string 6","cartId":7,"zipCode":"sample string 8"}

application/xml, text/xml

Sample:

<WebUserPaymentBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.WebIntegration">
  <AmountBilled>5</AmountBilled>
  <CartId>7</CartId>
  <ExpirationMonth>3</ExpirationMonth>
  <ExpirationYear>4</ExpirationYear>
  <PayeeFirstName>sample string 1</PayeeFirstName>
  <PayeeLastName>sample string 2</PayeeLastName>
  <PaymentProviderToken>sample string 6</PaymentProviderToken>
  <ZipCode>sample string 8</ZipCode>
</WebUserPaymentBindingModel>

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

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>