BootView WebApi

<back to all web services

GetPrePaymentAlerts

The following routes are available for this service:
GET/payments/alertsGets Pre-Payment Alerts for this Collection Attempt
GetPrePaymentAlerts Parameters:
NameParameterData TypeRequiredDescription
CollectionAttemptIdbodyGuidYesThe Collection Attempt Id.
PrePaymentAlerts Parameters:
NameParameterData TypeRequiredDescription
IsVehicleBeingTowedformboolNo
VehicleCancelledCheckOrChargebackAlertsformList<VehicleAlert>No
VehicleAlert Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
AlertTypeIdformintNo
NoteformstringNo
AlertTypeformstringNo
IsActiveformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetPrePaymentAlerts HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetPrePaymentAlerts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
</GetPrePaymentAlerts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PrePaymentAlerts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <IsVehicleBeingTowed>false</IsVehicleBeingTowed>
  <VehicleCancelledCheckOrChargebackAlerts>
    <VehicleAlert>
      <AlertType>String</AlertType>
      <AlertTypeId>0</AlertTypeId>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <IsActive>false</IsActive>
      <Note>String</Note>
    </VehicleAlert>
  </VehicleCancelledCheckOrChargebackAlerts>
</PrePaymentAlerts>