splitit-web-python-sdk
Advanced tools
Splitit's Web API
splitit.installment_plan.check_eligibilitysplitit.installment_plan.getsplitit.installment_plan.get_eligibility_terms_and_conditionsplitit.installment_plan.postsplitit.installment_plan.post2splitit.installment_plan.refundsplitit.installment_plan.searchsplitit.installment_plan.update_ordersplitit.installment_plan.update_order2splitit.installment_plan.verify_authorizationPython >=3.7
pip install splitit-web-python-sdk==3.0.9
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 support is available by prepending a to any method.
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())
splitit.installment_plan.check_eligibilitycheck_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",
)
strstrTouchPoint
PlanDataCardDataAddressDatastrCheckInstallmentsEligibilityRequest
InstallmentsEligibilityResponse
/api/installmentplans/check-eligibility post
splitit.installment_plan.getget_response = splitit.installment_plan.get(
installment_plan_number="installmentPlanNumber_example",
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
)
strstrstrTouchPoint
/api/installmentplans/{installmentPlanNumber} get
splitit.installment_plan.get_eligibility_terms_and_conditionget_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="",
)
)
strstrstrTouchPoint
EligibilityTermsAndConditionResponse
/api/installmentplans/{ipn}/legal get
splitit.installment_plan.postpost_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",
)
strstrTouchPoint
boolboolShopperDataPlanDataModelAddressDataModelInitiateRedirectionEndpointsModelUxSettingsModelEventsEndpointsModelProcessingDatastrstrstrInstallmentPlanInitiateRequest
/api/installmentplans/initiate post
splitit.installment_plan.post2post2_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",
)
boolboolstrstrTouchPoint
boolShopperDataPlanDataModelAddressDataModelPaymentMethodModelRedirectionEndpointsModelProcessingDataEventsEndpointsModelstrstrstr/api/installmentplans post
splitit.installment_plan.refundrefund_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",
)
Union[int, float]strstrstrTouchPoint
RefundStrategystr/api/installmentplans/{installmentPlanNumber}/refund post
splitit.installment_plan.searchsearch_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",
},
)
strstrTouchPoint
strstrDict[str, str]/api/installmentplans/search get
splitit.installment_plan.update_orderupdate_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,
)
strstrstrTouchPoint
strstrboolShippingStatusUnion[int, float]/api/installmentplans/{installmentPlanNumber}/updateorder put
splitit.installment_plan.update_order2update_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={},
)
strstrTouchPoint
strstrboolShippingStatusUnion[int, float]IdentifierContractInstallmentPlanUpdateRequestByIdentifier
/api/installmentplans/updateorder put
splitit.installment_plan.verify_authorizationverify_authorization_response = splitit.installment_plan.verify_authorization(
installment_plan_number="installmentPlanNumber_example",
x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
x_splitit_touch_point="",
)
strstrstrTouchPoint
/api/installmentplans/{installmentPlanNumber}/verifyauthorization get
This Python package is automatically generated by Konfig
FAQs
Client for splitit-web-api-v3
We found that splitit-web-python-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.