| Name | splitit-web-python-sdk JSON |
| Version |
3.0.8
JSON |
| download |
| home_page | None |
| Summary | Client for splitit-web-api-v3 |
| upload_time | 2024-11-19 10:44:24 |
| maintainer | None |
| docs_url | None |
| author | Konfig |
| requires_python | <4.0,>=3.7 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# splitit-web-python-sdk<a id="splitit-web-python-sdk"></a>
Splitit's Web API
[](https://pypi.org/project/splitit-web-python-sdk/3.0.8)
[](https://github.com/konfig-dev/splitit-web-sdks/tree/main/python#readme)
## Table of Contents<a id="table-of-contents"></a>
<!-- toc -->
- [Requirements](#requirements)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Async](#async)
- [Reference](#reference)
* [`splitit.installment_plan.check_eligibility`](#splititinstallment_plancheck_eligibility)
* [`splitit.installment_plan.get`](#splititinstallment_planget)
* [`splitit.installment_plan.get_eligibility_terms_and_condition`](#splititinstallment_planget_eligibility_terms_and_condition)
* [`splitit.installment_plan.post`](#splititinstallment_planpost)
* [`splitit.installment_plan.post2`](#splititinstallment_planpost2)
* [`splitit.installment_plan.refund`](#splititinstallment_planrefund)
* [`splitit.installment_plan.search`](#splititinstallment_plansearch)
* [`splitit.installment_plan.update_order`](#splititinstallment_planupdate_order)
* [`splitit.installment_plan.update_order2`](#splititinstallment_planupdate_order2)
* [`splitit.installment_plan.verify_authorization`](#splititinstallment_planverify_authorization)
<!-- tocstop -->
## Requirements<a id="requirements"></a>
Python >=3.7
## Installation<a id="installation"></a>
```sh
pip install splitit-web-python-sdk==3.0.8
```
## Getting Started<a id="getting-started"></a>
```python
from pprint import pprint
from splitit_client import Splitit, ApiException
splitit = Splitit(
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
try:
check_eligibility_response = splitit.installment_plan.check_eligibility(
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
plan_data={
"total_amount": 3.14,
"number_of_installments": 1,
"purchase_method": "InStore",
"strategy": "SecuredPlan",
},
card_details={
"card_brand": "Mastercard",
"card_type": "Credit",
},
billing_address={},
shopper_identifier="string_example",
)
pprint(check_eligibility_response.body)
pprint(check_eligibility_response.body["installment_provider"])
pprint(check_eligibility_response.body["payment_plan_options"])
pprint(check_eligibility_response.headers)
pprint(check_eligibility_response.status)
pprint(check_eligibility_response.round_trip_time)
except ApiException as e:
print("Exception when calling InstallmentPlanApi.check_eligibility: %s\n" % e)
pprint(e.body)
if e.status == 401:
pprint(e.body["trace_id"])
pprint(e.body["error"])
if e.status == 500:
pprint(e.body["trace_id"])
pprint(e.body["error"])
if e.status == 403:
pprint(e.body["trace_id"])
pprint(e.body["error"])
if e.status == 404:
pprint(e.body["trace_id"])
pprint(e.body["error"])
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
```
## Async<a id="async"></a>
`async` support is available by prepending `a` to any method.
```python
import asyncio
from pprint import pprint
from splitit_client import Splitit, ApiException
splitit = Splitit(
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
async def main():
try:
check_eligibility_response = await splitit.installment_plan.acheck_eligibility(
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
plan_data={
"total_amount": 3.14,
"number_of_installments": 1,
"purchase_method": "InStore",
"strategy": "SecuredPlan",
},
card_details={
"card_brand": "Mastercard",
"card_type": "Credit",
},
billing_address={},
shopper_identifier="string_example",
)
pprint(check_eligibility_response.body)
pprint(check_eligibility_response.body["installment_provider"])
pprint(check_eligibility_response.body["payment_plan_options"])
pprint(check_eligibility_response.headers)
pprint(check_eligibility_response.status)
pprint(check_eligibility_response.round_trip_time)
except ApiException as e:
print("Exception when calling InstallmentPlanApi.check_eligibility: %s\n" % e)
pprint(e.body)
if e.status == 401:
pprint(e.body["trace_id"])
pprint(e.body["error"])
if e.status == 500:
pprint(e.body["trace_id"])
pprint(e.body["error"])
if e.status == 403:
pprint(e.body["trace_id"])
pprint(e.body["error"])
if e.status == 404:
pprint(e.body["trace_id"])
pprint(e.body["error"])
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
asyncio.run(main())
```
## Reference<a id="reference"></a>
### `splitit.installment_plan.check_eligibility`<a id="splititinstallment_plancheck_eligibility"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
check_eligibility_response = splitit.installment_plan.check_eligibility(
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
plan_data={
"total_amount": 3.14,
"number_of_installments": 1,
"purchase_method": "InStore",
"strategy": "SecuredPlan",
},
card_details={
"card_brand": "Mastercard",
"card_type": "Credit",
},
billing_address={},
shopper_identifier="string_example",
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
##### plan_data: [`PlanData`](./splitit_client/type/plan_data.py)<a id="plan_data-plandatasplitit_clienttypeplan_datapy"></a>
##### card_details: [`CardData`](./splitit_client/type/card_data.py)<a id="card_details-carddatasplitit_clienttypecard_datapy"></a>
##### billing_address: [`AddressData`](./splitit_client/type/address_data.py)<a id="billing_address-addressdatasplitit_clienttypeaddress_datapy"></a>
##### shopper_identifier: `str`<a id="shopper_identifier-str"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`CheckInstallmentsEligibilityRequest`](./splitit_client/type/check_installments_eligibility_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`InstallmentsEligibilityResponse`](./splitit_client/type/installments_eligibility_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/check-eligibility` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.get`<a id="splititinstallment_planget"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_response = splitit.installment_plan.get(
installment_plan_number="installmentPlanNumber_example",
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### installment_plan_number: `str`<a id="installment_plan_number-str"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
#### 🔄 Return<a id="🔄-return"></a>
[`InstallmentPlanGetResponse`](./splitit_client/type/installment_plan_get_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/{installmentPlanNumber}` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.get_eligibility_terms_and_condition`<a id="splititinstallment_planget_eligibility_terms_and_condition"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
get_eligibility_terms_and_condition_response = (
splitit.installment_plan.get_eligibility_terms_and_condition(
ipn="ipn_example",
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
)
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### ipn: `str`<a id="ipn-str"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
#### 🔄 Return<a id="🔄-return"></a>
[`EligibilityTermsAndConditionResponse`](./splitit_client/type/eligibility_terms_and_condition_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/{ipn}/legal` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.post`<a id="splititinstallment_planpost"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post_response = splitit.installment_plan.post(
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
auto_capture=True,
attempt3d_secure=True,
shopper={},
plan_data={
"total_amount": 3.14,
"purchase_method": "InStore",
},
billing_address={},
redirect_urls={},
ux_settings={},
events_endpoints={},
processing_data={},
x_splitit_test_mode="None",
x_splitit_strategy="SecuredPlan",
splititclientinfo="string_example",
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
##### auto_capture: `bool`<a id="auto_capture-bool"></a>
##### attempt3d_secure: `bool`<a id="attempt3d_secure-bool"></a>
##### shopper: [`ShopperData`](./splitit_client/type/shopper_data.py)<a id="shopper-shopperdatasplitit_clienttypeshopper_datapy"></a>
##### plan_data: [`PlanDataModel`](./splitit_client/type/plan_data_model.py)<a id="plan_data-plandatamodelsplitit_clienttypeplan_data_modelpy"></a>
##### billing_address: [`AddressDataModel`](./splitit_client/type/address_data_model.py)<a id="billing_address-addressdatamodelsplitit_clienttypeaddress_data_modelpy"></a>
##### redirect_urls: [`InitiateRedirectionEndpointsModel`](./splitit_client/type/initiate_redirection_endpoints_model.py)<a id="redirect_urls-initiateredirectionendpointsmodelsplitit_clienttypeinitiate_redirection_endpoints_modelpy"></a>
##### ux_settings: [`UxSettingsModel`](./splitit_client/type/ux_settings_model.py)<a id="ux_settings-uxsettingsmodelsplitit_clienttypeux_settings_modelpy"></a>
##### events_endpoints: [`EventsEndpointsModel`](./splitit_client/type/events_endpoints_model.py)<a id="events_endpoints-eventsendpointsmodelsplitit_clienttypeevents_endpoints_modelpy"></a>
##### processing_data: [`ProcessingData`](./splitit_client/type/processing_data.py)<a id="processing_data-processingdatasplitit_clienttypeprocessing_datapy"></a>
##### x_splitit_test_mode: `str`<a id="x_splitit_test_mode-str"></a>
##### x_splitit_strategy: `str`<a id="x_splitit_strategy-str"></a>
##### splititclientinfo: `str`<a id="splititclientinfo-str"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`InstallmentPlanInitiateRequest`](./splitit_client/type/installment_plan_initiate_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`InitiatePlanResponse`](./splitit_client/type/initiate_plan_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/initiate` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.post2`<a id="splititinstallment_planpost2"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
post2_response = splitit.installment_plan.post2(
auto_capture=True,
terms_and_conditions_accepted=True,
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
attempt3d_secure=True,
shopper={},
plan_data={
"total_amount": 3.14,
"purchase_method": "InStore",
},
billing_address={},
payment_method={
"type": "Card",
},
redirect_urls={},
processing_data={},
events_endpoints={},
x_splitit_test_mode="None",
x_splitit_strategy="SecuredPlan",
splititclientinfo="string_example",
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### auto_capture: `bool`<a id="auto_capture-bool"></a>
##### terms_and_conditions_accepted: `bool`<a id="terms_and_conditions_accepted-bool"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
##### attempt3d_secure: `bool`<a id="attempt3d_secure-bool"></a>
##### shopper: [`ShopperData`](./splitit_client/type/shopper_data.py)<a id="shopper-shopperdatasplitit_clienttypeshopper_datapy"></a>
##### plan_data: [`PlanDataModel`](./splitit_client/type/plan_data_model.py)<a id="plan_data-plandatamodelsplitit_clienttypeplan_data_modelpy"></a>
##### billing_address: [`AddressDataModel`](./splitit_client/type/address_data_model.py)<a id="billing_address-addressdatamodelsplitit_clienttypeaddress_data_modelpy"></a>
##### payment_method: [`PaymentMethodModel`](./splitit_client/type/payment_method_model.py)<a id="payment_method-paymentmethodmodelsplitit_clienttypepayment_method_modelpy"></a>
##### redirect_urls: [`RedirectionEndpointsModel`](./splitit_client/type/redirection_endpoints_model.py)<a id="redirect_urls-redirectionendpointsmodelsplitit_clienttyperedirection_endpoints_modelpy"></a>
##### processing_data: [`ProcessingData`](./splitit_client/type/processing_data.py)<a id="processing_data-processingdatasplitit_clienttypeprocessing_datapy"></a>
##### events_endpoints: [`EventsEndpointsModel`](./splitit_client/type/events_endpoints_model.py)<a id="events_endpoints-eventsendpointsmodelsplitit_clienttypeevents_endpoints_modelpy"></a>
##### x_splitit_test_mode: `str`<a id="x_splitit_test_mode-str"></a>
##### x_splitit_strategy: `str`<a id="x_splitit_strategy-str"></a>
##### splititclientinfo: `str`<a id="splititclientinfo-str"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`InstallmentPlanCreateRequest`](./splitit_client/type/installment_plan_create_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`InstallmentPlanCreateResponse`](./splitit_client/type/installment_plan_create_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.refund`<a id="splititinstallment_planrefund"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
refund_response = splitit.installment_plan.refund(
amount=3.14,
installment_plan_number="installmentPlanNumber_example",
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
refund_strategy="FutureInstallmentsFirst",
reference_id="string_example",
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### amount: `Union[int, float]`<a id="amount-unionint-float"></a>
##### installment_plan_number: `str`<a id="installment_plan_number-str"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
##### refund_strategy: [`RefundStrategy`](./splitit_client/type/refund_strategy.py)<a id="refund_strategy-refundstrategysplitit_clienttyperefund_strategypy"></a>
##### reference_id: `str`<a id="reference_id-str"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`InstallmentPlanRefundRequest`](./splitit_client/type/installment_plan_refund_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`InstallmentPlanRefundResponse`](./splitit_client/type/installment_plan_refund_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/{installmentPlanNumber}/refund` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.search`<a id="splititinstallment_plansearch"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
search_response = splitit.installment_plan.search(
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
installment_plan_number="string_example",
ref_order_number="string_example",
extended_params={
"key": "string_example",
},
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
##### installment_plan_number: `str`<a id="installment_plan_number-str"></a>
##### ref_order_number: `str`<a id="ref_order_number-str"></a>
##### extended_params: [`Dict[str, str]`](./splitit_client/type/.py)<a id="extended_params-dictstr-strsplitit_clienttypepy"></a>
#### 🔄 Return<a id="🔄-return"></a>
[`InstallmentPlanSearchResponse`](./splitit_client/type/installment_plan_search_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/search` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.update_order`<a id="splititinstallment_planupdate_order"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
update_order_response = splitit.installment_plan.update_order(
installment_plan_number="installmentPlanNumber_example",
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
ref_order_number="string_example",
tracking_number="string_example",
capture=True,
shipping_status="Pending",
new_amount=3.14,
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### installment_plan_number: `str`<a id="installment_plan_number-str"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
##### ref_order_number: `str`<a id="ref_order_number-str"></a>
##### tracking_number: `str`<a id="tracking_number-str"></a>
##### capture: `bool`<a id="capture-bool"></a>
##### shipping_status: [`ShippingStatus`](./splitit_client/type/shipping_status.py)<a id="shipping_status-shippingstatussplitit_clienttypeshipping_statuspy"></a>
##### new_amount: `Union[int, float]`<a id="new_amount-unionint-float"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`InstallmentPlanUpdateRequest`](./splitit_client/type/installment_plan_update_request.py)
#### 🔄 Return<a id="🔄-return"></a>
[`InstallmentPlanUpdateResponse`](./splitit_client/type/installment_plan_update_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/{installmentPlanNumber}/updateorder` `put`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.update_order2`<a id="splititinstallment_planupdate_order2"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
update_order2_response = splitit.installment_plan.update_order2(
body=None,
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
ref_order_number="string_example",
tracking_number="string_example",
capture=True,
shipping_status="Pending",
new_amount=3.14,
identifier={},
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
##### ref_order_number: `str`<a id="ref_order_number-str"></a>
##### tracking_number: `str`<a id="tracking_number-str"></a>
##### capture: `bool`<a id="capture-bool"></a>
##### shipping_status: [`ShippingStatus`](./splitit_client/type/shipping_status.py)<a id="shipping_status-shippingstatussplitit_clienttypeshipping_statuspy"></a>
##### new_amount: `Union[int, float]`<a id="new_amount-unionint-float"></a>
##### identifier: [`IdentifierContract`](./splitit_client/type/identifier_contract.py)<a id="identifier-identifiercontractsplitit_clienttypeidentifier_contractpy"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`InstallmentPlanUpdateRequestByIdentifier`](./splitit_client/type/installment_plan_update_request_by_identifier.py)
#### 🔄 Return<a id="🔄-return"></a>
[`InstallmentPlanUpdateResponse`](./splitit_client/type/installment_plan_update_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/updateorder` `put`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `splitit.installment_plan.verify_authorization`<a id="splititinstallment_planverify_authorization"></a>
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
verify_authorization_response = splitit.installment_plan.verify_authorization(
installment_plan_number="installmentPlanNumber_example",
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### installment_plan_number: `str`<a id="installment_plan_number-str"></a>
##### x_splitit_idempotency_key: `str`<a id="x_splitit_idempotency_key-str"></a>
##### x_splitit_touch_point: `str`<a id="x_splitit_touch_point-str"></a>
TouchPoint
#### 🔄 Return<a id="🔄-return"></a>
[`VerifyAuthorizationResponse`](./splitit_client/type/verify_authorization_response.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/api/installmentplans/{installmentPlanNumber}/verifyauthorization` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
## Author<a id="author"></a>
This Python package is automatically generated by [Konfig](https://konfigthis.com)
Raw data
{
"_id": null,
"home_page": null,
"name": "splitit-web-python-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Konfig",
"author_email": "engineering@konfigthis.com",
"download_url": "https://files.pythonhosted.org/packages/0d/54/e3ec4cd4c68ec6f64fad5fac4f9144cbe9e803939120c2387f79f84bee2f/splitit_web_python_sdk-3.0.8.tar.gz",
"platform": null,
"description": "# splitit-web-python-sdk<a id=\"splitit-web-python-sdk\"></a>\n\nSplitit's Web API\n\n\n[](https://pypi.org/project/splitit-web-python-sdk/3.0.8)\n[](https://github.com/konfig-dev/splitit-web-sdks/tree/main/python#readme)\n\n## Table of Contents<a id=\"table-of-contents\"></a>\n\n<!-- toc -->\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Async](#async)\n- [Reference](#reference)\n * [`splitit.installment_plan.check_eligibility`](#splititinstallment_plancheck_eligibility)\n * [`splitit.installment_plan.get`](#splititinstallment_planget)\n * [`splitit.installment_plan.get_eligibility_terms_and_condition`](#splititinstallment_planget_eligibility_terms_and_condition)\n * [`splitit.installment_plan.post`](#splititinstallment_planpost)\n * [`splitit.installment_plan.post2`](#splititinstallment_planpost2)\n * [`splitit.installment_plan.refund`](#splititinstallment_planrefund)\n * [`splitit.installment_plan.search`](#splititinstallment_plansearch)\n * [`splitit.installment_plan.update_order`](#splititinstallment_planupdate_order)\n * [`splitit.installment_plan.update_order2`](#splititinstallment_planupdate_order2)\n * [`splitit.installment_plan.verify_authorization`](#splititinstallment_planverify_authorization)\n\n<!-- tocstop -->\n\n## Requirements<a id=\"requirements\"></a>\n\nPython >=3.7\n\n## Installation<a id=\"installation\"></a>\n\n```sh\npip install splitit-web-python-sdk==3.0.8\n```\n\n## Getting Started<a id=\"getting-started\"></a>\n\n```python\nfrom pprint import pprint\nfrom splitit_client import Splitit, ApiException\n\nsplitit = Splitit(\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\n\ntry:\n check_eligibility_response = splitit.installment_plan.check_eligibility(\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n plan_data={\n \"total_amount\": 3.14,\n \"number_of_installments\": 1,\n \"purchase_method\": \"InStore\",\n \"strategy\": \"SecuredPlan\",\n },\n card_details={\n \"card_brand\": \"Mastercard\",\n \"card_type\": \"Credit\",\n },\n billing_address={},\n shopper_identifier=\"string_example\",\n )\n pprint(check_eligibility_response.body)\n pprint(check_eligibility_response.body[\"installment_provider\"])\n pprint(check_eligibility_response.body[\"payment_plan_options\"])\n pprint(check_eligibility_response.headers)\n pprint(check_eligibility_response.status)\n pprint(check_eligibility_response.round_trip_time)\nexcept ApiException as e:\n print(\"Exception when calling InstallmentPlanApi.check_eligibility: %s\\n\" % e)\n pprint(e.body)\n if e.status == 401:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n if e.status == 500:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n if e.status == 403:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n if e.status == 404:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n```\n\n## Async<a id=\"async\"></a>\n\n`async` support is available by prepending `a` to any method.\n\n```python\nimport asyncio\nfrom pprint import pprint\nfrom splitit_client import Splitit, ApiException\n\nsplitit = Splitit(\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\",\n)\n\n\nasync def main():\n try:\n check_eligibility_response = await splitit.installment_plan.acheck_eligibility(\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n plan_data={\n \"total_amount\": 3.14,\n \"number_of_installments\": 1,\n \"purchase_method\": \"InStore\",\n \"strategy\": \"SecuredPlan\",\n },\n card_details={\n \"card_brand\": \"Mastercard\",\n \"card_type\": \"Credit\",\n },\n billing_address={},\n shopper_identifier=\"string_example\",\n )\n pprint(check_eligibility_response.body)\n pprint(check_eligibility_response.body[\"installment_provider\"])\n pprint(check_eligibility_response.body[\"payment_plan_options\"])\n pprint(check_eligibility_response.headers)\n pprint(check_eligibility_response.status)\n pprint(check_eligibility_response.round_trip_time)\n except ApiException as e:\n print(\"Exception when calling InstallmentPlanApi.check_eligibility: %s\\n\" % e)\n pprint(e.body)\n if e.status == 401:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n if e.status == 500:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n if e.status == 403:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n if e.status == 404:\n pprint(e.body[\"trace_id\"])\n pprint(e.body[\"error\"])\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n\n\nasyncio.run(main())\n```\n\n\n## Reference<a id=\"reference\"></a>\n### `splitit.installment_plan.check_eligibility`<a id=\"splititinstallment_plancheck_eligibility\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\ncheck_eligibility_response = splitit.installment_plan.check_eligibility(\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n plan_data={\n \"total_amount\": 3.14,\n \"number_of_installments\": 1,\n \"purchase_method\": \"InStore\",\n \"strategy\": \"SecuredPlan\",\n },\n card_details={\n \"card_brand\": \"Mastercard\",\n \"card_type\": \"Credit\",\n },\n billing_address={},\n shopper_identifier=\"string_example\",\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n##### plan_data: [`PlanData`](./splitit_client/type/plan_data.py)<a id=\"plan_data-plandatasplitit_clienttypeplan_datapy\"></a>\n\n\n##### card_details: [`CardData`](./splitit_client/type/card_data.py)<a id=\"card_details-carddatasplitit_clienttypecard_datapy\"></a>\n\n\n##### billing_address: [`AddressData`](./splitit_client/type/address_data.py)<a id=\"billing_address-addressdatasplitit_clienttypeaddress_datapy\"></a>\n\n\n##### shopper_identifier: `str`<a id=\"shopper_identifier-str\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`CheckInstallmentsEligibilityRequest`](./splitit_client/type/check_installments_eligibility_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InstallmentsEligibilityResponse`](./splitit_client/type/installments_eligibility_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/check-eligibility` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.get`<a id=\"splititinstallment_planget\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_response = splitit.installment_plan.get(\n installment_plan_number=\"installmentPlanNumber_example\",\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### installment_plan_number: `str`<a id=\"installment_plan_number-str\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InstallmentPlanGetResponse`](./splitit_client/type/installment_plan_get_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/{installmentPlanNumber}` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.get_eligibility_terms_and_condition`<a id=\"splititinstallment_planget_eligibility_terms_and_condition\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nget_eligibility_terms_and_condition_response = (\n splitit.installment_plan.get_eligibility_terms_and_condition(\n ipn=\"ipn_example\",\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n )\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### ipn: `str`<a id=\"ipn-str\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`EligibilityTermsAndConditionResponse`](./splitit_client/type/eligibility_terms_and_condition_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/{ipn}/legal` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.post`<a id=\"splititinstallment_planpost\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost_response = splitit.installment_plan.post(\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n auto_capture=True,\n attempt3d_secure=True,\n shopper={},\n plan_data={\n \"total_amount\": 3.14,\n \"purchase_method\": \"InStore\",\n },\n billing_address={},\n redirect_urls={},\n ux_settings={},\n events_endpoints={},\n processing_data={},\n x_splitit_test_mode=\"None\",\n x_splitit_strategy=\"SecuredPlan\",\n splititclientinfo=\"string_example\",\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n##### auto_capture: `bool`<a id=\"auto_capture-bool\"></a>\n\n##### attempt3d_secure: `bool`<a id=\"attempt3d_secure-bool\"></a>\n\n##### shopper: [`ShopperData`](./splitit_client/type/shopper_data.py)<a id=\"shopper-shopperdatasplitit_clienttypeshopper_datapy\"></a>\n\n\n##### plan_data: [`PlanDataModel`](./splitit_client/type/plan_data_model.py)<a id=\"plan_data-plandatamodelsplitit_clienttypeplan_data_modelpy\"></a>\n\n\n##### billing_address: [`AddressDataModel`](./splitit_client/type/address_data_model.py)<a id=\"billing_address-addressdatamodelsplitit_clienttypeaddress_data_modelpy\"></a>\n\n\n##### redirect_urls: [`InitiateRedirectionEndpointsModel`](./splitit_client/type/initiate_redirection_endpoints_model.py)<a id=\"redirect_urls-initiateredirectionendpointsmodelsplitit_clienttypeinitiate_redirection_endpoints_modelpy\"></a>\n\n\n##### ux_settings: [`UxSettingsModel`](./splitit_client/type/ux_settings_model.py)<a id=\"ux_settings-uxsettingsmodelsplitit_clienttypeux_settings_modelpy\"></a>\n\n\n##### events_endpoints: [`EventsEndpointsModel`](./splitit_client/type/events_endpoints_model.py)<a id=\"events_endpoints-eventsendpointsmodelsplitit_clienttypeevents_endpoints_modelpy\"></a>\n\n\n##### processing_data: [`ProcessingData`](./splitit_client/type/processing_data.py)<a id=\"processing_data-processingdatasplitit_clienttypeprocessing_datapy\"></a>\n\n\n##### x_splitit_test_mode: `str`<a id=\"x_splitit_test_mode-str\"></a>\n\n##### x_splitit_strategy: `str`<a id=\"x_splitit_strategy-str\"></a>\n\n##### splititclientinfo: `str`<a id=\"splititclientinfo-str\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`InstallmentPlanInitiateRequest`](./splitit_client/type/installment_plan_initiate_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InitiatePlanResponse`](./splitit_client/type/initiate_plan_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/initiate` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.post2`<a id=\"splititinstallment_planpost2\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\npost2_response = splitit.installment_plan.post2(\n auto_capture=True,\n terms_and_conditions_accepted=True,\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n attempt3d_secure=True,\n shopper={},\n plan_data={\n \"total_amount\": 3.14,\n \"purchase_method\": \"InStore\",\n },\n billing_address={},\n payment_method={\n \"type\": \"Card\",\n },\n redirect_urls={},\n processing_data={},\n events_endpoints={},\n x_splitit_test_mode=\"None\",\n x_splitit_strategy=\"SecuredPlan\",\n splititclientinfo=\"string_example\",\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### auto_capture: `bool`<a id=\"auto_capture-bool\"></a>\n\n##### terms_and_conditions_accepted: `bool`<a id=\"terms_and_conditions_accepted-bool\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n##### attempt3d_secure: `bool`<a id=\"attempt3d_secure-bool\"></a>\n\n##### shopper: [`ShopperData`](./splitit_client/type/shopper_data.py)<a id=\"shopper-shopperdatasplitit_clienttypeshopper_datapy\"></a>\n\n\n##### plan_data: [`PlanDataModel`](./splitit_client/type/plan_data_model.py)<a id=\"plan_data-plandatamodelsplitit_clienttypeplan_data_modelpy\"></a>\n\n\n##### billing_address: [`AddressDataModel`](./splitit_client/type/address_data_model.py)<a id=\"billing_address-addressdatamodelsplitit_clienttypeaddress_data_modelpy\"></a>\n\n\n##### payment_method: [`PaymentMethodModel`](./splitit_client/type/payment_method_model.py)<a id=\"payment_method-paymentmethodmodelsplitit_clienttypepayment_method_modelpy\"></a>\n\n\n##### redirect_urls: [`RedirectionEndpointsModel`](./splitit_client/type/redirection_endpoints_model.py)<a id=\"redirect_urls-redirectionendpointsmodelsplitit_clienttyperedirection_endpoints_modelpy\"></a>\n\n\n##### processing_data: [`ProcessingData`](./splitit_client/type/processing_data.py)<a id=\"processing_data-processingdatasplitit_clienttypeprocessing_datapy\"></a>\n\n\n##### events_endpoints: [`EventsEndpointsModel`](./splitit_client/type/events_endpoints_model.py)<a id=\"events_endpoints-eventsendpointsmodelsplitit_clienttypeevents_endpoints_modelpy\"></a>\n\n\n##### x_splitit_test_mode: `str`<a id=\"x_splitit_test_mode-str\"></a>\n\n##### x_splitit_strategy: `str`<a id=\"x_splitit_strategy-str\"></a>\n\n##### splititclientinfo: `str`<a id=\"splititclientinfo-str\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`InstallmentPlanCreateRequest`](./splitit_client/type/installment_plan_create_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InstallmentPlanCreateResponse`](./splitit_client/type/installment_plan_create_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.refund`<a id=\"splititinstallment_planrefund\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nrefund_response = splitit.installment_plan.refund(\n amount=3.14,\n installment_plan_number=\"installmentPlanNumber_example\",\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n refund_strategy=\"FutureInstallmentsFirst\",\n reference_id=\"string_example\",\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### amount: `Union[int, float]`<a id=\"amount-unionint-float\"></a>\n\n##### installment_plan_number: `str`<a id=\"installment_plan_number-str\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n##### refund_strategy: [`RefundStrategy`](./splitit_client/type/refund_strategy.py)<a id=\"refund_strategy-refundstrategysplitit_clienttyperefund_strategypy\"></a>\n\n##### reference_id: `str`<a id=\"reference_id-str\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`InstallmentPlanRefundRequest`](./splitit_client/type/installment_plan_refund_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InstallmentPlanRefundResponse`](./splitit_client/type/installment_plan_refund_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/{installmentPlanNumber}/refund` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.search`<a id=\"splititinstallment_plansearch\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nsearch_response = splitit.installment_plan.search(\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n installment_plan_number=\"string_example\",\n ref_order_number=\"string_example\",\n extended_params={\n \"key\": \"string_example\",\n },\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n##### installment_plan_number: `str`<a id=\"installment_plan_number-str\"></a>\n\n##### ref_order_number: `str`<a id=\"ref_order_number-str\"></a>\n\n##### extended_params: [`Dict[str, str]`](./splitit_client/type/.py)<a id=\"extended_params-dictstr-strsplitit_clienttypepy\"></a>\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InstallmentPlanSearchResponse`](./splitit_client/type/installment_plan_search_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/search` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.update_order`<a id=\"splititinstallment_planupdate_order\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nupdate_order_response = splitit.installment_plan.update_order(\n installment_plan_number=\"installmentPlanNumber_example\",\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n ref_order_number=\"string_example\",\n tracking_number=\"string_example\",\n capture=True,\n shipping_status=\"Pending\",\n new_amount=3.14,\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### installment_plan_number: `str`<a id=\"installment_plan_number-str\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n##### ref_order_number: `str`<a id=\"ref_order_number-str\"></a>\n\n##### tracking_number: `str`<a id=\"tracking_number-str\"></a>\n\n##### capture: `bool`<a id=\"capture-bool\"></a>\n\n##### shipping_status: [`ShippingStatus`](./splitit_client/type/shipping_status.py)<a id=\"shipping_status-shippingstatussplitit_clienttypeshipping_statuspy\"></a>\n\n##### new_amount: `Union[int, float]`<a id=\"new_amount-unionint-float\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`InstallmentPlanUpdateRequest`](./splitit_client/type/installment_plan_update_request.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InstallmentPlanUpdateResponse`](./splitit_client/type/installment_plan_update_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/{installmentPlanNumber}/updateorder` `put`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.update_order2`<a id=\"splititinstallment_planupdate_order2\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nupdate_order2_response = splitit.installment_plan.update_order2(\n body=None,\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n ref_order_number=\"string_example\",\n tracking_number=\"string_example\",\n capture=True,\n shipping_status=\"Pending\",\n new_amount=3.14,\n identifier={},\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n##### ref_order_number: `str`<a id=\"ref_order_number-str\"></a>\n\n##### tracking_number: `str`<a id=\"tracking_number-str\"></a>\n\n##### capture: `bool`<a id=\"capture-bool\"></a>\n\n##### shipping_status: [`ShippingStatus`](./splitit_client/type/shipping_status.py)<a id=\"shipping_status-shippingstatussplitit_clienttypeshipping_statuspy\"></a>\n\n##### new_amount: `Union[int, float]`<a id=\"new_amount-unionint-float\"></a>\n\n##### identifier: [`IdentifierContract`](./splitit_client/type/identifier_contract.py)<a id=\"identifier-identifiercontractsplitit_clienttypeidentifier_contractpy\"></a>\n\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`InstallmentPlanUpdateRequestByIdentifier`](./splitit_client/type/installment_plan_update_request_by_identifier.py)\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`InstallmentPlanUpdateResponse`](./splitit_client/type/installment_plan_update_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/updateorder` `put`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `splitit.installment_plan.verify_authorization`<a id=\"splititinstallment_planverify_authorization\"></a>\n\n\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nverify_authorization_response = splitit.installment_plan.verify_authorization(\n installment_plan_number=\"installmentPlanNumber_example\",\n x_splitit_idempotency_key=\"X-Splitit-IdempotencyKey_example\",\n x_splitit_touch_point=\"\",\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### installment_plan_number: `str`<a id=\"installment_plan_number-str\"></a>\n\n##### x_splitit_idempotency_key: `str`<a id=\"x_splitit_idempotency_key-str\"></a>\n\n##### x_splitit_touch_point: `str`<a id=\"x_splitit_touch_point-str\"></a>\n\nTouchPoint\n\n#### \ud83d\udd04 Return<a id=\"\ud83d\udd04-return\"></a>\n\n[`VerifyAuthorizationResponse`](./splitit_client/type/verify_authorization_response.py)\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/api/installmentplans/{installmentPlanNumber}/verifyauthorization` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n\n## Author<a id=\"author\"></a>\nThis Python package is automatically generated by [Konfig](https://konfigthis.com)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client for splitit-web-api-v3",
"version": "3.0.8",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a17ae340b9f29991b918258e449c1f5636b8e387de5d0a111cb9019913e5bdde",
"md5": "c5cd7ae070dcfe11a5bdb4ebc4d0d58f",
"sha256": "bc805d0799f53fdd9802832ae089c381cca8b69727c7e8555556a64d9a94906b"
},
"downloads": -1,
"filename": "splitit_web_python_sdk-3.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5cd7ae070dcfe11a5bdb4ebc4d0d58f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 330812,
"upload_time": "2024-11-19T10:44:22",
"upload_time_iso_8601": "2024-11-19T10:44:22.466134Z",
"url": "https://files.pythonhosted.org/packages/a1/7a/e340b9f29991b918258e449c1f5636b8e387de5d0a111cb9019913e5bdde/splitit_web_python_sdk-3.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d54e3ec4cd4c68ec6f64fad5fac4f9144cbe9e803939120c2387f79f84bee2f",
"md5": "f615d5dc3d113da9d4a0cd8f9bf9ffcd",
"sha256": "3c4aa63b9c5086a09e5ec31167121bfa97093c59a3166a8f05ab13d0abab41f5"
},
"downloads": -1,
"filename": "splitit_web_python_sdk-3.0.8.tar.gz",
"has_sig": false,
"md5_digest": "f615d5dc3d113da9d4a0cd8f9bf9ffcd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 109143,
"upload_time": "2024-11-19T10:44:24",
"upload_time_iso_8601": "2024-11-19T10:44:24.738163Z",
"url": "https://files.pythonhosted.org/packages/0d/54/e3ec4cd4c68ec6f64fad5fac4f9144cbe9e803939120c2387f79f84bee2f/splitit_web_python_sdk-3.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 10:44:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "splitit-web-python-sdk"
}
