BootView WebApi

FindPayments

The following routes are available for this service:
GET	/payments	Find all the payments that meet the search criteria

**FindPayments** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	query	Guid	No	The customer Id for which we want the payments.
LicenseTag	query	string	No	The license tag.
LicenseState	query	string	No	The license state.
CarMakeModel	query	string	No	The car make and model.
CarColor	query	string	No	The car color.
Followup	query	bool	No	Whether the record is flagged for followup.
Name	query	string	No	The name.
ProcessedBy	query	string	No	The person who processed the payment.
PaymentType	query	string	No	The payment type.
CardType	query	int	No	The type of card used for payment.
PaidFrom	query	DateTime	No	The earliest payment date.
PaidTo	query	DateTime	No	The most recent payment date.
StickerId	query	string	No	The sticker Id.
PaymentMin	body	string	Yes	The minimum payment to use in the serach.
PaymentMax	body	string	Yes	The maximum payment to use in the search.
PaymentSuccess	query	string	No	Search for successful, unsuccessful, or all payments.
CardNumberLastFour	query	string	No	The last 4 digits of the card number used for payment.
AuthorizationCode	query	string	No	The Authorization Code to search for
SortField	query	string	No	The sort field.
PageIndex	query	int	No	The page index.
PageSize	query	int	No	Number of results to return.

**PaymentSearchResultItem** Parameters:
Name	Parameter	Data Type	Required
StickerId	form	string	No
CustomerCode	form	string	No
LicenseTag	form	string	No
LicenseState	form	string	No
CarMakeModel	form	string	No
CarColor	form	string	No
FirstName	form	string	No
LastName	form	string	No
Phonenumber	form	string	No
BootedOn	form	DateTime	No
PaymentAmount	form	decimal	No
CollectionAttemptId	form	Guid	No
PaymentId	form	Guid	No
PaymentType	form	string	No
UserName	form	string	No
VLname	form	string	No
VFname	form	string	No
Successful	form	string	No
ReferenceDate	form	string	No
TransactionNumber	form	string	No
AllowRefund	form	bool	No

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.

GET /payments HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentSearchResultItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AllowRefund>false</AllowRefund>
  <BootedOn>0001-01-01T00:00:00</BootedOn>
  <CarColor>String</CarColor>
  <CarMakeModel>String</CarMakeModel>
  <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
  <CustomerCode>String</CustomerCode>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <LicenseState>String</LicenseState>
  <LicenseTag>String</LicenseTag>
  <PaymentAmount>0</PaymentAmount>
  <PaymentId>00000000-0000-0000-0000-000000000000</PaymentId>
  <PaymentType>String</PaymentType>
  <Phonenumber>String</Phonenumber>
  <ReferenceDate>String</ReferenceDate>
  <StickerId>String</StickerId>
  <Successful>String</Successful>
  <TransactionNumber>String</TransactionNumber>
  <UserName>String</UserName>
  <VFname>String</VFname>
  <VLname>String</VLname>
</PaymentSearchResultItem>