Skip to main content

splitit-web-api-v3

Project description

splitit-web-python-sdk

Splitit's Web API

  • API version: 1.0.0
  • Package version: 2.0.0

Requirements.

Python >=3.7

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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

(you may need to run pip with root permission: sudo pip install splitit-web-python-sdk==2.0.0)

Then import the package:

import splitit_client

Getting Started

Please follow the installation procedure and then run the following:

from pprint import pprint
from splitit_client import Splitit

splitit = Splitit(
    # Defining the host is optional and defaults to https://web-api-v3.sandbox.splitit.com
    # See configuration.py for a list of all supported configuration parameters.
    host = "https://web-api-v3.sandbox.splitit.com",

    # Configure OAuth2 access token for authorization: oauth
    access_token = 'YOUR_ACCESS_TOKEN'
)

cancel_response = splitit.installment_plan.cancel(
    path_params = {
        'installmentPlanNumber': "installmentPlanNumber_example",
    },
    header_params = {
        'X-Splitit-IdempotencyKey': "X-Splitit-IdempotencyKey_example",
    },
)
try:
    pprint(cancel_response.body["installment_plan_number"])
    pprint(cancel_response.headers)
    pprint(cancel_response.status)
except ApiException as e:
    print("Exception when calling InstallmentPlanCancelResponse.cancel: %s\n" % e)
    pprint(e.body)
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)

Documentation for API Endpoints

All URIs are relative to https://web-api-v3.sandbox.splitit.com

Class Method HTTP request Description
InstallmentPlanApi cancel post /api/installmentplans/{installmentPlanNumber}/cancel
InstallmentPlanApi check_eligibility post /api/installmentplans/check-eligibility
InstallmentPlanApi get get /api/installmentplans/{installmentPlanNumber}
InstallmentPlanApi post post /api/installmentplans/initiate
InstallmentPlanApi post2 post /api/installmentplans
InstallmentPlanApi refund post /api/installmentplans/{installmentPlanNumber}/refund
InstallmentPlanApi search get /api/installmentplans/search
InstallmentPlanApi update_order put /api/installmentplans/{installmentPlanNumber}/updateorder
InstallmentPlanApi update_order2 put /api/installmentplans/updateorder
InstallmentPlanApi verify_authorization get /api/installmentplans/{installmentPlanNumber}/verifyauthorization

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • api.v3:

Author

This Python package is automatically generated by Konfig

Project details


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

Uploaded Source

Built Distribution

splitit_web_python_sdk-2.0.0-py3-none-any.whl (147.1 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