get
https://www.katapult.com/api/v3/application/funding/
Transmits funding/settlement information to be considered by the retailer
For the funding status request please use private token provided in authorization header
Funding Filter Parameters
| Parameter | Example Value | Data Type |
|---|---|---|
| start | 2020-01-14 | string |
| end | 2020-03-14 | string |
| date_filter | funded_date, effective_date, origination_date | string |
| application_id | 12345 | integer |
| limit | 25 (defaults to 20) | integer |
| offset | 30 (defaults to 0) | integer |
| refund | true/false | boolean |
| funded | true/false | boolean |
| payment_settled | true/false | boolean |
Sample cURL Request with date_filter Applied
curl --location --request GET
'https://sandbox.katapult.com/api/v3/application/funding/?date_filter=origination_date&end=2020
-08-26&start=2020-08-20' \
--header 'Authorization: Bearer Katapult_Private_Token' \
--header 'Accept: application/json'
Response Attributes for funding_report objects
| Attribute | Description | Data Type |
|---|---|---|
| application_id | Katapult application id associated with the record | integer |
| consumer_discount | Discount provided to the customer at checkout by the retailer | decimal |
| delivery | Delivery or shipping fee charged to the customer | decimal |
| delivery_date | The delivery date submitted to Katpault from the merchant | string |
| discount | Merchant discount fee | decimal |
| effective_date | Date funding is effective on | string |
| first_name | Customers first name | string |
| last_name | Customers last name | string |
| funded | T/F if the order has been funded | boolean |
| funded_date | The date funding was processed by Katapult | string |
| funding_id | Funding id associated to the order | integer |
| gross_funding_amount | Total value of the order before discount(s) | decimal |
| leasable | Total value of leasable items on the order | decimal |
| lease_status | Reflects the leases current status | string |
| net_funding_amount | Total value being funded to the retailer | decimal |
| nonleasable | Total value of non leasable items on the order | decimal |
| order_id | Order id associated with the record | string |
| origination_date | Date the order was created | string |
| uid | Unique multi-character identifier that refers to a singular lease/order | string |
Funding Status Errors
| Errors | HTTP status | Description |
|---|---|---|
| NOT FOUND | 404 | Using Public Token in Authorization Header |
| UNAUTHORIZED | 401 | Invalid Authorization Token |