Client for splitit-web-api-v3

These details have not been verified by PyPI

Project description

splitit-web-python-sdk

Splitit's Web API

Requirements
Installation
Getting Started
Async
Reference

Requirements

Python >=3.7

Installation

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

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",
        },
        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",
            },
            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",
    },
    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.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",
    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`

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",
    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`

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

These details have not been verified by PyPI

Release history Release notifications | RSS feed

3.0.7

Oct 21, 2024

3.0.6

Oct 9, 2024

3.0.5

Sep 30, 2024

3.0.4

Sep 19, 2024

3.0.3

Sep 9, 2024

3.0.2

Jul 22, 2024

This version

3.0.1

Jun 24, 2024

3.0.0

Mar 24, 2024

2.6.8

Feb 20, 2024

2.6.7

Feb 19, 2024

2.6.6

Feb 14, 2024

2.6.5

Feb 7, 2024

2.6.4

Feb 6, 2024

2.6.3

Jan 31, 2024

2.6.2

Dec 20, 2023

2.6.1

Nov 7, 2023

2.6.0

Sep 5, 2023

2.5.0

Jun 27, 2023

2.4.0

Jun 21, 2023

2.3.0

Jun 12, 2023

2.2.0

Jun 8, 2023

2.1.0

Apr 25, 2023

2.0.0

Mar 24, 2023

1.1.0

Jan 30, 2023

1.0.2

Jan 18, 2023

1.0.1

Jan 10, 2023

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.1.tar.gz (102.8 kB view hashes)

Uploaded Jun 24, 2024 Source

Built Distribution

splitit_web_python_sdk-3.0.1-py3-none-any.whl (316.9 kB view hashes)

Uploaded Jun 24, 2024 Python 3

Hashes for splitit_web_python_sdk-3.0.1.tar.gz

Hashes for splitit_web_python_sdk-3.0.1.tar.gz
Algorithm	Hash digest
SHA256	`8559625075c378872cbcf7c12120ab18fdb5b48ff315f9b2ac11d6ca3276c10b`
MD5	`bc9f4b21068e5658643dfd4fc0655869`
BLAKE2b-256	`e88ded4882d63af077babc939f443fa4af1ea2b51e9f9fa01d855d3d4e7866ca`

Hashes for splitit_web_python_sdk-3.0.1-py3-none-any.whl

Hashes for splitit_web_python_sdk-3.0.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`07bf320ebe0361dc8390c6177847502c5142b898b96b21f63b13bf9b485d3750`
MD5	`4e1b4f3e8d97780a2b8bfde38c90366e`
BLAKE2b-256	`37bb9c98047c5c56539dacb3eef81d76c5d664284beea601e066f309d24576bd`

splitit-web-python-sdk 3.0.1

Navigation

Verified details

Maintainers

Unverified details

Meta

Classifiers

Project description

splitit-web-python-sdk

Table of Contents

Requirements

Installation

Getting Started

Async

Reference

splitit.installment_plan.check_eligibility

🛠️ Usage

⚙️ Parameters

x_splitit_idempotency_key: str

x_splitit_touch_point: str

plan_data: PlanData

card_details: CardData

billing_address: AddressData

shopper_identifier: str

⚙️ Request Body

🔄 Return

🌐 Endpoint

splitit.installment_plan.get

🛠️ Usage

⚙️ Parameters

installment_plan_number: str

x_splitit_idempotency_key: str

x_splitit_touch_point: str

🔄 Return

🌐 Endpoint

splitit.installment_plan.post

🛠️ Usage

⚙️ Parameters

x_splitit_idempotency_key: str

x_splitit_touch_point: str

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

splititclientinfo: str

⚙️ Request Body

🔄 Return

🌐 Endpoint

splitit.installment_plan.post2

🛠️ Usage

⚙️ Parameters

auto_capture: bool

terms_and_conditions_accepted: bool

x_splitit_idempotency_key: str

x_splitit_touch_point: str

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

splititclientinfo: str

⚙️ Request Body

🔄 Return

🌐 Endpoint

splitit.installment_plan.refund

🛠️ Usage

⚙️ Parameters

amount: Union[int, float]

installment_plan_number: str

x_splitit_idempotency_key: str

`splitit.installment_plan.check_eligibility`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

plan_data: `PlanData`

card_details: `CardData`

billing_address: `AddressData`

shopper_identifier: `str`

`splitit.installment_plan.get`

installment_plan_number: `str`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

`splitit.installment_plan.post`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

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`

splititclientinfo: `str`

`splitit.installment_plan.post2`

auto_capture: `bool`

terms_and_conditions_accepted: `bool`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

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`

splititclientinfo: `str`

`splitit.installment_plan.refund`

amount: `Union[int, float]`

installment_plan_number: `str`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

refund_strategy: `RefundStrategy`

reference_id: `str`

`splitit.installment_plan.search`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

installment_plan_number: `str`

ref_order_number: `str`

extended_params: `Dict[str, str]`

`splitit.installment_plan.update_order`

installment_plan_number: `str`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

ref_order_number: `str`

tracking_number: `str`

capture: `bool`

shipping_status: `ShippingStatus`

new_amount: `Union[int, float]`

`splitit.installment_plan.update_order2`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`

ref_order_number: `str`

tracking_number: `str`

capture: `bool`

shipping_status: `ShippingStatus`

new_amount: `Union[int, float]`

identifier: `IdentifierContract`

`splitit.installment_plan.verify_authorization`

installment_plan_number: `str`

x_splitit_idempotency_key: `str`

x_splitit_touch_point: `str`