BootView WebApi

<back to all web services

CreatePaylockPaymentPlan

The following routes are available for this service:
POST/collectionattempts/createpaylockpaymentplanCreates a PayLock payment plan on a Collection Attempt.
CreatePaylockPaymentPlan Parameters:
NameParameterData TypeRequiredDescription
IdquerystringYesThe sticker Id.
CustomerIdqueryGuidYesThe customer Id for which we want the boot record.
StartDatequeryDateTimeNoThe payment plan start date.
CardTokenNumberquerystringNoThe card token number.
CreateBootRecordResult Parameters:
NameParameterData TypeRequiredDescription
CollectionAttemptIdformGuidNo

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

{
	id: String,
	customerId: 00000000000000000000000000000000,
	startDate: 0001-01-01,
	cardTokenNumber: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	collectionAttemptId: 00000000000000000000000000000000
}