| POST | /collectionattempts/createpaylockpaymentplanpayment | Creates a PayLock payment plan payment on a Collection Attempt. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | string | Yes | The sticker Id. |
| CustomerId | query | Guid | Yes | The customer Id for which we want the boot record. |
| PaymentAmount | body | decimal | Yes | The Payment Amount to distribute on the collection attempt bills |
| ServiceFeeAmount | body | decimal | No | The Service Fee Amount for this payment |
| ConvenienceFee | body | decimal | No | The Convenience Fee Amount for this payment |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionAttemptId | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
paymentAmount: 0,
serviceFeeAmount: 0,
convenienceFee: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
collectionAttemptId: 00000000000000000000000000000000
}