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 .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.

POST /collectionattempts/createpaylockpaymentplan HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreatePaylockPaymentPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CardTokenNumber>String</CardTokenNumber>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <Id>String</Id>
  <StartDate>0001-01-01T00:00:00</StartDate>
</CreatePaylockPaymentPlan>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateBootRecordResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
</CreateBootRecordResult>