BootView WebApi

<back to all web services

GetPayment

The following routes are available for this service:
GET/payment/{collectionattemptid}Gets the payment
GetPayment Parameters:
NameParameterData TypeRequiredDescription
CollectionAttemptIdpathGuidYesThe Collection Attempt Id. Must have this and/or PaymentId.
PaymentIdbodyGuidNoThe Payment Id. Must have this and/or CollectionAttemptId
CustomerIdbodyGuidYesThe Customer Id. Must have this and/or PaymentId.
PaymentMethodbodyintNoThe Payment Method.
PaymentActionbodyintNoThe Payment Action.
GetPaymentResult Parameters:
NameParameterData TypeRequiredDescription
NetDueformdecimalNo
PaymentMethodformstringNo
PaymentGatewayNameformstringNo
IsCardInfoValidformboolNo
IsRefundformboolNo
IsVoidformboolNo
ConvenienceFeeformConvenienceFeeNo
PrePaymentAlertsformPrePaymentAlertsNo
GatewayAcceptedPaymentTypesformList<string>No
CardDetailsformCommonCardModelNo
PaymentformPaymentNo
ConvenienceFee Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
PaymentGatewayIdformGuid?No
PaymentTypeformstringNo
MinRangeformdecimal?No
MaxRangeformdecimal?No
FeeAmountformdecimal?No
ApplyAtPaymentOfBootformbool?No
ApplyAtPaymentOfNoticeformbool?No
ApplyAtPaymentOfTowformbool?No
TotalPaymentAmountformdecimal?No
ApplyConvenienceFeeformbool?No
PrePaymentAlerts Parameters:
NameParameterData TypeRequiredDescription
IsVehicleBeingTowedformboolNo
VehicleCancelledCheckOrChargebackAlertsformList<VehicleAlert>No
VehicleAlert Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
AlertTypeIdformintNo
NoteformstringNo
AlertTypeformstringNo
IsActiveformboolNo
CommonCardModel Parameters:
NameParameterData TypeRequiredDescription
CardModelformCardModelNo
CommonECheckModelformECheckModelNo
PaymentGatewayNameformstringNo
CardTokenNumberformstringNo
HiddenCardNumberformstringNo
CardModel Parameters:
NameParameterData TypeRequiredDescription
CardNumberformstringNo
CardExpiryMonthformintNo
CardExpiryYearformintNo
CardSecurityCodebodystringNocvv number
ECheckModel Parameters:
NameParameterData TypeRequiredDescription
CheckNumberbodystringNoCheck Number, required for E-check Payments
BankNamebodystringNoBank Name, required for E-check Payments
AccountNumberbodystringNoAccount Number, required for E-check Payments
AccountTypebodyintNoAccount Type, required for E-check Payments
RoutingNumberbodystringNoRouting Number, required for E-check Payments
IdTypebodystringNoIdentification Type, required for E-check Payments
StateForIdTypebodystringNoState in which the Idnentification was issued, required for E-check Payments
IdNumberbodystringNoIdnentification Number, required for E-check Payments
Payment Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TransactionNumberformintNo
OriginatingAttemptIdformGuid?No
BatchNumberformintNo
TotalAmountformdecimalNo
PlacedDateformDateTimeNo
IsSuccessfulformboolNo
PaymentTypeformstringNo
CreatedByUserIdformGuidNo
FirstNameformstringNo
LastNameformstringNo
PhoneformstringNo
EmailformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateCodeformstringNo
PostalCodeformstringNo
CountryCodeformstringNo
PaymentNoteformstringNo
IsDeletedformboolNo
CustomerIdformGuidNo
CustomerReceiptNumberformstringNo
CustomerReceiptDateformDateTime?No
TotalAllocatedformdecimalNo
CreatedByUserNameformstringNo

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/GetPayment HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	collectionAttemptId: 00000000000000000000000000000000,
	paymentId: 00000000000000000000000000000000,
	customerId: 00000000000000000000000000000000,
	paymentMethod: 0,
	paymentAction: 0
}
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
	}
}