BootView WebApi

<back to all web services

CreatePaylockPaymentPlanPayment

The following routes are available for this service:
POST/collectionattempts/createpaylockpaymentplanpaymentCreates a PayLock payment plan on a Collection Attempt.
CreatePaylockPaymentPlanPayment Parameters:
NameParameterData TypeRequiredDescription
IdquerystringYesThe sticker Id.
CustomerIdqueryGuidYesThe customer Id for which we want the boot record.
PaymentAmountbodydecimalYesThe Payment Amount to distribute on the collection attempt bills
ServiceFeeAmountbodydecimalNoThe Service Fee Amount to for this payment
CreateBootRecordResult Parameters:
NameParameterData TypeRequiredDescription
CollectionAttemptIdformGuidNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /collectionattempts/createpaylockpaymentplanpayment HTTP/1.1 
Host: api.paylock.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","customerId":"00000000000000000000000000000000","paymentAmount":0,"serviceFeeAmount":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"collectionAttemptId":"00000000000000000000000000000000"}