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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	collectionAttemptId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	isVehicleBeingTowed: False,
	vehicleCancelledCheckOrChargebackAlerts: 
	[
		{
			id: 00000000000000000000000000000000,
			alertTypeId: 0,
			note: String,
			alertType: String,
			isActive: False
		}
	]
}