Sample Postman Collection to Sandbox Environment
Below is a sample postman collection of different API endpoints to import and use within our sandbox environment. This collction contains endpoints that will allow you to process and integrate with Okinus/Breeze. You may download it here.
{
"info": {
"_postman_id": "e636b02b-7431-481e-96d1-e3c958410143",
"name": "Sample API Collection for Integrators",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "18897787",
"_collection_link": "https://okinusit.postman.co/workspace/Okinus-Workspace~40818c3e-0d5a-48f5-8f23-8163fbc1b50c/collection/18897787-e636b02b-7431-481e-96d1-e3c958410143?action=share&source=collection_link&creator=18897787"
},
"item": [
{
"name": "Payment Calculator",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"application_id\": \"{{application_id}}\",\r\n \"option\": \"string\",\r\n \"paymentFrequency\": \"string\",\r\n \"rating\": 0,\r\n \"modelVersion\": 0,\r\n \"score\": 0,\r\n \"leaseAmount\": 0,\r\n \"additionalDown\": 0,\r\n \"incomeFrequency\": \"string\",\r\n \"companyState\": \"string\",\r\n \"zipCode\": \"string\",\r\n \"ocpIncluded\": true\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/score/payments",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"score",
"payments"
]
}
},
"response": []
},
{
"name": "Applications -OptionA",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"store_id\":\"{{store_id}}\",\r\n \"applicant\":{\r\n \"location\":{\r\n \"city\":\"no city\",\r\n \"code\":\"94571\",\r\n \"country\":\"US\",\r\n \"line_1\":\"123 Street\",\r\n \"line_2\":\"None\",\r\n \"state\":\"UT\"\r\n },\r\n \"first_name\":\"Test\",\r\n \"last_name\":\"OptionA\",\r\n \"social_security_number\":\"902653184\",\r\n \"date_of_birth\":\"1991-10-10\",\r\n \"email\":\"sample@example.com\",\r\n \"identification\":\"555124567\",\r\n \"identification_issuer\":\"GA\",\r\n \"phone\":2089568745,\r\n \"cell\":2084561234,\r\n \"primaryIncome\":{\r\n \"source\":\"employment\",\r\n \"employer\":\"employer\",\r\n \"gross\":3000.0,\r\n \"pay_date\":\"2025-05-05\",\r\n \"phone\":2084567845,\r\n \"frequency\":\"monthly\",\r\n \"direct_deposit\":true,\r\n \"first_pay_day\":5,\r\n \"second_pay_day\":20,\r\n \"title_department\":\"NA\"\r\n }\r\n },\r\n \"banking\":{\r\n \"opened_at\":\"2016-01-01\",\r\n \"routing_number\":\"123456789\",\r\n \"checking_account\":\"123456789\",\r\n \"bank_name\":\"BANK\"\r\n }\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/applications",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"applications"
]
}
},
"response": []
},
{
"name": "Applications -OptionB",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"store_id\":\"{{store_id}}\",\r\n \"applicant\":{\r\n \"location\":{\r\n \"city\":\"no city\",\r\n \"code\":\"94571\",\r\n \"country\":\"US\",\r\n \"line_1\":\"123 Street\",\r\n \"line_2\":\"None\",\r\n \"state\":\"UT\"\r\n },\r\n \"first_name\":\"Test\",\r\n \"last_name\":\"OptionB\",\r\n \"social_security_number\":\"902653184\",\r\n \"date_of_birth\":\"1991-10-10\",\r\n \"email\":\"sample@example.com\",\r\n \"identification\":\"555124567\",\r\n \"identification_issuer\":\"GA\",\r\n \"phone\":2089568745,\r\n \"cell\":2084561234,\r\n \"primaryIncome\":{\r\n \"source\":\"employment\",\r\n \"employer\":\"employer\",\r\n \"gross\":3000.0,\r\n \"pay_date\":\"2025-05-05\",\r\n \"phone\":2084567845,\r\n \"frequency\":\"monthly\",\r\n \"direct_deposit\":true,\r\n \"first_pay_day\":5,\r\n \"second_pay_day\":20,\r\n \"title_department\":\"NA\"\r\n }\r\n },\r\n \"banking\":{\r\n \"opened_at\":\"2016-01-01\",\r\n \"routing_number\":\"123456789\",\r\n \"checking_account\":\"123456789\",\r\n \"bank_name\":\"BANK\"\r\n }\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/applications",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"applications"
]
}
},
"response": []
},
{
"name": "Applications -Denial",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"store_id\":\"{{store_id}}\",\r\n \"applicant\":{\r\n \"location\":{\r\n \"city\":\"no city\",\r\n \"code\":\"94571\",\r\n \"country\":\"US\",\r\n \"line_1\":\"123 Street\",\r\n \"line_2\":\"None\",\r\n \"state\":\"UT\"\r\n },\r\n \"first_name\":\"Test\",\r\n \"last_name\":\"Decline\",\r\n \"social_security_number\":\"902653184\",\r\n \"date_of_birth\":\"1991-10-10\",\r\n \"email\":\"sample@example.com\",\r\n \"identification\":\"555124567\",\r\n \"identification_issuer\":\"GA\",\r\n \"phone\":2089568745,\r\n \"cell\":2084561234,\r\n \"primaryIncome\":{\r\n \"source\":\"employment\",\r\n \"employer\":\"employer\",\r\n \"gross\":3000.0,\r\n \"pay_date\":\"2025-05-05\",\r\n \"phone\":2084567845,\r\n \"frequency\":\"monthly\",\r\n \"direct_deposit\":true,\r\n \"first_pay_day\":5,\r\n \"second_pay_day\":20,\r\n \"title_department\":\"NA\"\r\n }\r\n },\r\n \"banking\":{\r\n \"opened_at\":\"2016-01-01\",\r\n \"routing_number\":\"123456789\",\r\n \"checking_account\":\"123456789\",\r\n \"bank_name\":\"BANK\"\r\n }\r\n}\r\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/applications",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"applications"
]
}
},
"response": []
},
{
"name": "Create/Calculate Lease",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"application_id\": \"{{application_id}}\",\r\n \"include_warranty\": true,\r\n \"option\": \"a\",\r\n \"deliveryCharge\": 0,\r\n \"additionalDown\": 0,\r\n \"storeWillCollect\": 0,\r\n \"proposed_down_payment\": 0,\r\n \"esign_type\": \"embedded\",\r\n \"esign_return_url\": \"string\",\r\n \"paymentFrequency\": \"bi-weekly\",\r\n \"primary_language\": \"en\",\r\n \"discard_esign\": true,\r\n \"create_esign\": true,\r\n \"ocp_included\": true,\r\n \"items\": [\r\n {\r\n \"sku\": \"string\",\r\n \"quantity\": 0,\r\n \"unit_price\": 0,\r\n \"description\": \"string\"\r\n }\r\n ],\r\n \"sales_person\": {\r\n \"name\": \"string\",\r\n \"email\": \"string\",\r\n \"phone\": \"string\"\r\n }\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/leases",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"leases"
]
}
},
"response": []
},
{
"name": "Request Down Payment Link",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"return_url\": \"string\",\r\n \"cancel_url\": \"string\",\r\n \"send_email\": true\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/commerce/leases/{{application_id}}/downpayment",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"commerce",
"leases",
"{{application_id}}",
"downpayment"
]
}
},
"response": []
},
{
"name": "Request Funding",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"date\": \"string\",\r\n \"comment\": \"string\",\r\n \"parts\": [\r\n {\r\n \"model\": \"string\",\r\n \"serial\": \"string\"\r\n }\r\n ]\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/commerce/leases/{{application_id}}/delivered",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"commerce",
"leases",
"{{application_id}}",
"delivered"
]
}
},
"response": []
},
{
"name": "Cancel Funding Request",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"application_id\": \"{{application_id}}\",\r\n \"comment\":\"string\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/commerce/leases/{{application_id}}/cancel_delivery",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"commerce",
"leases",
"{{application_id}}",
"cancel_delivery"
]
}
},
"response": []
},
{
"name": "Cancel Lease",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"application_id\": \"{{application_id}}\",\r\n \"comment\":\"string\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/commerce/leases/{{application_id}}/cancel",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"commerce",
"leases",
"{{application_id}}",
"cancel"
]
}
},
"response": []
},
{
"name": "Group Application Search",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"purchase_group\":\"string\",\r\n \"page\":1,\r\n \"stores\":\"{{store_id}}\",\r\n \"statuses\":[\"L\"],\r\n \"sort_by\":\"string\",\r\n \"sort_order\":\"string\",\r\n \"date_from\":\"string\",\r\n \"date_to\": \"string\",\r\n \"date_type\":\"string\"\r\n} ",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/applications/groups",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"applications",
"groups"
]
}
},
"response": []
},
{
"name": "Retrieve Application",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://beta2.okinus.com/api/v1/applications/{{application_id}}",
"protocol": "https",
"host": [
"beta2",
"okinus",
"com"
],
"path": [
"api",
"v1",
"applications",
"{{application_id}}"
]
}
},
"response": []
}
],
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "UhDgSIpaXivUJYTTXvqjK7FIrTXYN1xY3s5NiYnpE79ilDI4DN9ITrQ7rJceVL97OqR1vn1Cz6muiC1N",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [""]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [""]
}
}
],
"variable": [
{
"key": "application_id",
"value": "",
"type": "string"
},
{
"key": "store_id",
"value": "",
"type": "string"
},
{
"key": "checkout_id",
"value": "",
"type": "string"
},
{
"key": "base_url",
"value": "",
"type": "string"
}
]
}