post https://www.katapult.com/api/v3/application/initialize/
To begin the checkout, we must open the checkout by submitting the full contents of the shopping cart.
Requested Attributes
Attribute | Data Type | Description | Required Format |
---|---|---|---|
code | string | verification code sent to the customer's mobile device | 6 digit number |
first_name | string | first name of the customer's billing information | none |
middle_name | string | customer's middle name | none |
last_name | string | last name of the customer's billing information | none |
address | string | customer's line 1 of billing address | none |
address2 | string | customer's line 2 of billing address | none |
city | string | customer's billing city | none |
state | string | customer's billing state | 2 char state abbrev. |
country | string | customer's billing country | US |
zip | string | customer's billing zip code | 5 digit |
phone | string | customer's phone number | 10 digit number |
string | customer's email address to receive lease agreement and notifications | none | |
display_name | string | name of the item in the cart | none |
sku | string | retailer defined and specific stock keeping unit to identify the product/item in the cart | limit of 127 characters |
unit_price | string or integer input, string output | cash price of and item at a quantity of 1 | number |
quantity | integer | number of a speicfic item in the cart | number |
leasable | boolean | indication if the warranty is leasable or not | true / false |
customer_id | string | retailer specific identifier per customer | none |
discount_name | string | name of discount being applied to the cart | number |
discount_amount | string | $ amount of discount being applied to the cart | number |
phone | string | customer's phone number | 10 digit number |
new_address | boolean | indication if the user is new or returning | true / false |
shipping_amount | decimal | total shipping amount of the order | number |
Request Payload
{
"code": "123456",
"customer": {
"billing": {
"first_name": "jane",
"middle_name": "Q",
"last_name": "doe",
"address": "123 main street",
"address2": "apt 5b",
"city": "New York",
"state": "NY",
"country": "United States",
"zip": "10009",
"phone": "5554324537",
"email": "[email protected]"
},
"shipping": {
"first_name": "jane",
"middle_name": "Q",
"last_name": "doe",
"address": "123 main street",
"address2": "apt 5b",
"city": "New York",
"state": "NY",
"country": "United States",
"zip": "10009",
"phone": "5554324537",
"email": "[email protected]"
}
},
"items": [
{
"display_name": "Furniture Set",
"sku": "FS3525",
"unit_price": 700,
"quantity": 1,
"leasable": true,
"warranty": {
"price": 100,
"display_name": "warranty name",
"sku": "warranty sku"
}
},
{
"display_name": "AA Batteries",
"sku": "AA5234",
"unit_price": 15,
"quantity": 1,
"leasable": false
}
],
"checkout": {
"customer_id": "1000438727823",
"shipping_amount": 20.00,
"discounts": [
{
"discount_name": "Birthday Discount",
"discount_amount": 50
},
{
"discount_name": "Towel Discount",
"discount_amount": 50
}
]
},
"urls": {
"return": false,
"cancel": false
},
"phone": "6073393582",
"new_address": false
}
Initialize the Lease for Checkout
Error | HTTP status | Description |
---|---|---|
NOT FOUND | 404 | No User Found |
BAD REQUEST | 400 | Validation Error / Input Fields Differ From What Was Provided During Preapproval |
INTERNAL SERVER ERROR | 500 | Invalid Request Payload |
UNAUTHORIZED | 401 | Invalid Authorization Token |