Kickserv APIv2 - Payment Request Object

This documention is neither written nor endorsed by Kickserv. It has not been reviewed by Kickserv for accuracy and the API is entirely unsupported. It may work, it may not. You are responsible for anything that you do using the API and Kickserv can't undo it for you. Use at your own risk.

Mouseover the JSON key to see a brief description of each key. Keys that either haven't been identified (or that we haven't gotten around to adding yet) will show 'XXX'. Keys that are light gray are obsolete/legacy but still are returned in API responses.

If you're using Kickserv's Stripe Integration you can send SMS and email requests for payment. When that's been done a new object is inserted into the job's object. While multiple payment requests can be sent, the ID assigned for the first request is the same for the second, third, etc. A customer can pay through any of them, but functionally that means there is, a most, one payment request in a job object (the most recent).

Pay close attention to the 'amount' key. While one would expect $125.37 to be stored as '125.37' it's actually stored as '12537'. Note that the 'paid' key is specific to whether payment was received through that request. If a customer pays money some other way, that key will be 'false' even though full payment was recorded. Whether a manual payment through Stripe causes this flag to be set has not been tested. The 'message' key isn't shown anywhere in the web UI so this object is the only way to see what message was sent, at present.

If you spot a mistake or know the purpose of an undescribed key please let us know by emailing kickservapi@veildg.com.

{
"id": 19191919,
"job_id": 39028231,
"amount": 146427,
"creator_id": 454545,
"message": "Just Barrels, LLC has requested a payment for job #85270. Contact us with questions!",
"paid": false,
"created_at": "2022-05-09T14:47:52-04:00",
"updated_at": "2022-05-09T14:47:52-04:00"
}