Client for splitit-web-api-v3

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for konfig from gravatar.com konfig

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Konfig
  • Requires: Python <4.0, >=3.7
Classifiers

Project description

splitit-web-python-sdk

Splitit's Web API

PyPI README.md

Table of Contents

Requirements

Python >=3.7

Installation

pip install splitit-web-python-sdk==3.0.5

Getting Started

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

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())

Reference

splitit.installment_plan.check_eligibility

๐Ÿ› ๏ธ Usage

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

x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

plan_data: PlanData
card_details: CardData
billing_address: AddressData
shopper_identifier: str

โš™๏ธ Request Body

CheckInstallmentsEligibilityRequest

๐Ÿ”„ Return

InstallmentsEligibilityResponse

๐ŸŒ Endpoint

/api/installmentplans/check-eligibility post

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.get

๐Ÿ› ๏ธ Usage

get_response = splitit.installment_plan.get(
    installment_plan_number="installmentPlanNumber_example",
    x_splitit_idempotency_key="X-Splitit-IdempotencyKey_example",
    x_splitit_touch_point="",
)

โš™๏ธ Parameters

installment_plan_number: str
x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

๐Ÿ”„ Return

InstallmentPlanGetResponse

๐ŸŒ Endpoint

/api/installmentplans/{installmentPlanNumber} get

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.get_eligibility_terms_and_condition

๐Ÿ› ๏ธ Usage

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

ipn: str
x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

๐Ÿ”„ Return

EligibilityTermsAndConditionResponse

๐ŸŒ Endpoint

/api/installmentplans/{ipn}/legal get

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.post

๐Ÿ› ๏ธ Usage

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

x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

auto_capture: bool
attempt3d_secure: bool
shopper: ShopperData
plan_data: PlanDataModel
billing_address: AddressDataModel
redirect_urls: InitiateRedirectionEndpointsModel
ux_settings: UxSettingsModel
events_endpoints: EventsEndpointsModel
processing_data: ProcessingData
x_splitit_test_mode: str
x_splitit_strategy: str
splititclientinfo: str

โš™๏ธ Request Body

InstallmentPlanInitiateRequest

๐Ÿ”„ Return

InitiatePlanResponse

๐ŸŒ Endpoint

/api/installmentplans/initiate post

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.post2

๐Ÿ› ๏ธ Usage

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

auto_capture: bool
terms_and_conditions_accepted: bool
x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

attempt3d_secure: bool
shopper: ShopperData
plan_data: PlanDataModel
billing_address: AddressDataModel
payment_method: PaymentMethodModel
redirect_urls: RedirectionEndpointsModel
processing_data: ProcessingData
events_endpoints: EventsEndpointsModel
x_splitit_test_mode: str
x_splitit_strategy: str
splititclientinfo: str

โš™๏ธ Request Body

InstallmentPlanCreateRequest

๐Ÿ”„ Return

InstallmentPlanCreateResponse

๐ŸŒ Endpoint

/api/installmentplans post

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.refund

๐Ÿ› ๏ธ Usage

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

amount: Union[int, float]
installment_plan_number: str
x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

refund_strategy: RefundStrategy
reference_id: str

โš™๏ธ Request Body

InstallmentPlanRefundRequest

๐Ÿ”„ Return

InstallmentPlanRefundResponse

๐ŸŒ Endpoint

/api/installmentplans/{installmentPlanNumber}/refund post

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.search

๐Ÿ› ๏ธ Usage

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

x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

installment_plan_number: str
ref_order_number: str
extended_params: Dict[str, str]

๐Ÿ”„ Return

InstallmentPlanSearchResponse

๐ŸŒ Endpoint

/api/installmentplans/search get

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.update_order

๐Ÿ› ๏ธ Usage

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

installment_plan_number: str
x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

ref_order_number: str
tracking_number: str
capture: bool
shipping_status: ShippingStatus
new_amount: Union[int, float]

โš™๏ธ Request Body

InstallmentPlanUpdateRequest

๐Ÿ”„ Return

InstallmentPlanUpdateResponse

๐ŸŒ Endpoint

/api/installmentplans/{installmentPlanNumber}/updateorder put

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.update_order2

๐Ÿ› ๏ธ Usage

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

x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

ref_order_number: str
tracking_number: str
capture: bool
shipping_status: ShippingStatus
new_amount: Union[int, float]
identifier: IdentifierContract

โš™๏ธ Request Body

InstallmentPlanUpdateRequestByIdentifier

๐Ÿ”„ Return

InstallmentPlanUpdateResponse

๐ŸŒ Endpoint

/api/installmentplans/updateorder put

๐Ÿ”™ Back to Table of Contents

splitit.installment_plan.verify_authorization

๐Ÿ› ๏ธ Usage

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

installment_plan_number: str
x_splitit_idempotency_key: str
x_splitit_touch_point: str

TouchPoint

๐Ÿ”„ Return

VerifyAuthorizationResponse

๐ŸŒ Endpoint

/api/installmentplans/{installmentPlanNumber}/verifyauthorization get

๐Ÿ”™ Back to Table of Contents

Author

This Python package is automatically generated by Konfig

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for konfig from gravatar.com konfig

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Konfig
  • Requires: Python <4.0, >=3.7
Classifiers

Release history Release notifications | RSS feed

3.0.7

3.0.6

This version

3.0.5

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.0

2.4.0

2.3.0

2.2.0

2.1.0

2.0.0

1.1.0

1.0.2

1.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

splitit_web_python_sdk-3.0.5.tar.gz (109.0 kB view hashes)

Uploaded Source

Built Distribution

splitit_web_python_sdk-3.0.5-py3-none-any.whl (330.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page