BootView WebApi

<back to all web services

FindPayments

The following routes are available for this service:
GET/paymentsFind all the payments that meet the search criteria
FindPayments Parameters:
NameParameterData TypeRequiredDescription
CustomerIdqueryGuidNoThe customer Id for which we want the payments.
LicenseTagquerystringNoThe license tag.
LicenseStatequerystringNoThe license state.
CarMakeModelquerystringNoThe car make and model.
CarColorquerystringNoThe car color.
FollowupqueryboolNoWhether the record is flagged for followup.
NamequerystringNoThe name.
ProcessedByquerystringNoThe person who processed the payment.
PaymentTypequerystringNoThe payment type.
CardTypequeryintNoThe type of card used for payment.
PaidFromqueryDateTimeNoThe earliest payment date.
PaidToqueryDateTimeNoThe most recent payment date.
StickerIdquerystringNoThe sticker Id.
PaymentMinbodystringYesThe minimum payment to use in the serach.
PaymentMaxbodystringYesThe maximum payment to use in the search.
PaymentSuccessquerystringNoSearch for successful, unsuccessful, or all payments.
CardNumberLastFourquerystringNoThe last 4 digits of the card number used for payment.
AuthorizationCodequerystringNoThe Authorization Code to search for
SortFieldquerystringNoThe sort field.
PageIndexqueryintNoThe page index.
PageSizequeryintNoNumber of results to return.
PaymentSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
StickerIdformstringNo
CustomerCodeformstringNo
LicenseTagformstringNo
LicenseStateformstringNo
CarMakeModelformstringNo
CarColorformstringNo
FirstNameformstringNo
LastNameformstringNo
PhonenumberformstringNo
BootedOnformDateTimeNo
PaymentAmountformdecimalNo
CollectionAttemptIdformGuidNo
PaymentIdformGuidNo
PaymentTypeformstringNo
UserNameformstringNo
VLnameformstringNo
VFnameformstringNo
SuccessfulformstringNo
ReferenceDateformstringNo
TransactionNumberformstringNo
AllowRefundformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"customerId":"00000000000000000000000000000000","licenseTag":"String","licenseState":"String","carMakeModel":"String","carColor":"String","followup":false,"name":"String","processedBy":"String","paymentType":"String","cardType":0,"paidFrom":"\/Date(-62135596800000-0000)\/","paidTo":"\/Date(-62135596800000-0000)\/","stickerId":"String","paymentMin":"String","paymentMax":"String","paymentSuccess":"String","cardNumberLastFour":"String","authorizationCode":"String","sortField":"String","pageIndex":0,"pageSize":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"stickerId":"String","customerCode":"String","licenseTag":"String","licenseState":"String","carMakeModel":"String","carColor":"String","firstName":"String","lastName":"String","phonenumber":"String","bootedOn":"\/Date(-62135596800000-0000)\/","paymentAmount":0,"collectionAttemptId":"00000000000000000000000000000000","paymentId":"00000000000000000000000000000000","paymentType":"String","userName":"String","vLname":"String","vFname":"String","successful":"String","referenceDate":"String","transactionNumber":"String","allowRefund":false}