BootView WebApi

<back to all web services

CreatePayment

The following routes are available for this service:
POST/collectionattempts/{id}/paymentsCreates a payment.
CreatePayment Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesColletion attempt id to apply the payment to
PaymentTokenbodystringYesToken for payment info provided by the payment processing gateway
PaymentAmountbodydecimalYesThe Payment Amount without Convenience fees
ConvenienceFeebodydecimalNoThe convenience fee
PayorbodyobjectYesPayor information
CardTypebodystringYesThe type of card being used: visa, master, american_express, discover, jcb, diners_club, dankort
LastFourbodystringYesThe last 4 digits of the card being used
FingerprintbodystringYesThe card fingerprint from spreedly
PaymentMethodbodystringNoThe Payment Method: CC, DC, EC, CP, OTHER DEFAULTS ....to CC when not defined
IsFeePaymentbodyboolYesare we paying fees?, if so, we will use the fee gateway to process those fees
Payor Parameters:
NameParameterData TypeRequiredDescription
FirstNamebodystringYesFirst name of the person making the payment
LastNamebodystringYesLast name of the person making the payment
AddressbodystringNoAddress of the person making the payment -Default Values will be inserted if not supplied to meet data inetgrity rules
Address2bodystringNoAddress2 of the person making the payment
CitybodystringNoCity of the person making the payment -Default Values will be inserted if not supplied to meet data inetgrity rules
StatebodystringNoState of the person making the payment-Default Values will be inserted if not supplied to meet data inetgrity rules
CountrybodystringNoCountry Code of the person making the payment--Default Values will be inserted if not supplied to meet data inetgrity rules
ZipbodystringNoZip Code of the person making the payment
EmailbodystringNoEmail of the person making the payment--Default Values will be inserted if not supplied to meet data inetgrity rules
PhonebodystringNoPhone of the person making the payment
NotebodystringNoNote taken regarding the person making the payment
CreatePaymentResult Parameters:
NameParameterData TypeRequiredDescription
ResultformPaymentProcessingResultNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsformList<string>No
PaymentProcessingResult Parameters:
NameParameterData TypeRequiredDescription
PaymentIdformGuidNoGuid/unique identifier for the payment
OriginatingAttemptIdformGuidNoGuid/unique identifier reference to the original attempt
AmountAppliedformdecimalNo
PaymentProcessingOutcomeformPaymentProcessingOutcomeNo
IsSuccessfulformboolNo

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

{
	id: 00000000000000000000000000000000,
	paymentToken: String,
	paymentAmount: 0,
	convenienceFee: 0,
	payor: 
	{
		firstName: String,
		lastName: String,
		address: String,
		address2: String,
		city: String,
		state: String,
		country: String,
		zip: String,
		email: String,
		phone: String,
		note: String
	},
	cardType: String,
	lastFour: String,
	fingerprint: String,
	paymentMethod: String,
	isFeePayment: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		paymentId: 00000000000000000000000000000000,
		originatingAttemptId: 00000000000000000000000000000000,
		amountApplied: 0,
		paymentProcessingOutcome: 0,
		isSuccessful: False
	},
	errors: 
	[
		String
	]
}