BootView WebApi

GetPayment

The following routes are available for this service:
GET	/payment/{collectionattemptid}	Gets the payment

**GetPayment** Parameters:
Name	Parameter	Data Type	Required	Description
CollectionAttemptId	path	Guid	Yes	The Collection Attempt Id. Must have this and/or PaymentId.
PaymentId	body	Guid	No	The Payment Id. Must have this and/or CollectionAttemptId
CustomerId	body	Guid	Yes	The Customer Id. Must have this and/or PaymentId.
PaymentMethod	body	int	No	The Payment Method.
PaymentAction	body	int	No	The Payment Action.

**GetPaymentResult** Parameters:
Name	Parameter	Data Type	Required
NetDue	form	decimal	No
PaymentMethod	form	string	No
PaymentGatewayName	form	string	No
IsCardInfoValid	form	bool	No
IsRefund	form	bool	No
IsVoid	form	bool	No
ConvenienceFee	form	ConvenienceFee	No
PrePaymentAlerts	form	PrePaymentAlerts	No
GatewayAcceptedPaymentTypes	form	List<string>	No
CardDetails	form	CommonCardModel	No
Payment	form	Payment	No

**ConvenienceFee** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
PaymentGatewayId	form	Guid?	No
PaymentType	form	string	No
MinRange	form	decimal?	No
MaxRange	form	decimal?	No
FeeAmount	form	decimal?	No
ApplyAtPaymentOfBoot	form	bool?	No
ApplyAtPaymentOfNotice	form	bool?	No
ApplyAtPaymentOfTow	form	bool?	No
TotalPaymentAmount	form	decimal?	No
ApplyConvenienceFee	form	bool?	No

**PrePaymentAlerts** Parameters:
Name	Parameter	Data Type	Required	Description
IsVehicleBeingTowed	form	bool	No
VehicleCancelledCheckOrChargebackAlerts	form	List<VehicleAlert>	No

**VehicleAlert** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
AlertTypeId	form	int	No
Note	form	string	No
AlertType	form	string	No
IsActive	form	bool	No

**CommonCardModel** Parameters:
Name	Parameter	Data Type	Required
CardModel	form	CardModel	No
CommonECheckModel	form	ECheckModel	No
PaymentGatewayName	form	string	No
CardTokenNumber	form	string	No
HiddenCardNumber	form	string	No

**CardModel** Parameters:
Name	Parameter	Data Type	Required	Description
CardNumber	form	string	No
CardExpiryMonth	form	int	No
CardExpiryYear	form	int	No
CardSecurityCode	body	string	No	cvv number

**ECheckModel** Parameters:
Name	Parameter	Data Type	Required	Description
CheckNumber	body	string	No	Check Number, required for E-check Payments
BankName	body	string	No	Bank Name, required for E-check Payments
AccountNumber	body	string	No	Account Number, required for E-check Payments
AccountType	body	int	No	Account Type, required for E-check Payments
RoutingNumber	body	string	No	Routing Number, required for E-check Payments
IdType	body	string	No	Identification Type, required for E-check Payments
StateForIdType	body	string	No	State in which the Idnentification was issued, required for E-check Payments
IdNumber	body	string	No	Idnentification Number, required for E-check Payments

**Payment** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
TransactionNumber	form	int	No
OriginatingAttemptId	form	Guid?	No
BatchNumber	form	int	No
TotalAmount	form	decimal	No
PlacedDate	form	DateTime	No
IsSuccessful	form	bool	No
PaymentType	form	string	No
CreatedByUserId	form	Guid	No
FirstName	form	string	No
LastName	form	string	No
Phone	form	string	No
Email	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
StateCode	form	string	No
PostalCode	form	string	No
CountryCode	form	string	No
PaymentNote	form	string	No
IsDeleted	form	bool	No
CustomerId	form	Guid	No
CustomerReceiptNumber	form	string	No
CustomerReceiptDate	form	DateTime?	No
TotalAllocated	form	decimal	No
CreatedByUserName	form	string	No

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.

GET /payment/{collectionattemptid} HTTP/1.1 
Host: api.paylock.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	netDue: 0,
	paymentMethod: String,
	paymentGatewayName: String,
	isCardInfoValid: False,
	isRefund: False,
	isVoid: False,
	convenienceFee: 
	{
		id: 00000000000000000000000000000000,
		paymentGatewayId: 00000000000000000000000000000000,
		paymentType: String,
		minRange: 0,
		maxRange: 0,
		feeAmount: 0,
		applyAtPaymentOfBoot: False,
		applyAtPaymentOfNotice: False,
		applyAtPaymentOfTow: False,
		totalPaymentAmount: 0,
		applyConvenienceFee: False
	},
	prePaymentAlerts: 
	{
		isVehicleBeingTowed: False,
		vehicleCancelledCheckOrChargebackAlerts: 
		[
			{
				id: 00000000000000000000000000000000,
				alertTypeId: 0,
				note: String,
				alertType: String,
				isActive: False
			}
		]
	},
	gatewayAcceptedPaymentTypes: 
	[
		String
	],
	cardDetails: 
	{
		cardModel: 
		{
			cardNumber: String,
			cardExpiryMonth: 0,
			cardExpiryYear: 0,
			cardSecurityCode: String
		},
		commonECheckModel: 
		{
			checkNumber: String,
			bankName: String,
			accountNumber: String,
			accountType: 0,
			routingNumber: String,
			idType: String,
			stateForIdType: String,
			idNumber: String
		},
		paymentGatewayName: String,
		cardTokenNumber: String,
		hiddenCardNumber: String
	}
}