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.1.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.1.0

(you may need to run pip with root permission: sudo pip install splitit-web-python-sdk==2.1.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'
)

try:
    cancel_response = splitit.installment_plan.cancel(
        path_params = {
            'installmentPlanNumber': "installmentPlanNumber_example",
        },
        header_params = {
            'X-Splitit-IdempotencyKey': "X-Splitit-IdempotencyKey_example",
        },
    )
    pprint(cancel_response.body)
    pprint(cancel_response.body["installment_plan_number"])
    pprint(cancel_response.headers)
    pprint(cancel_response.status)
    pprint(cancel_response.round_trip_time)
except ApiException as e:
    print("Exception when calling InstallmentPlanApi.cancel: %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)

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.1.0.tar.gz (79.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

splitit_web_python_sdk-2.1.0-py3-none-any.whl (149.1 kB view details)

Uploaded Python 3

File details

Details for the file splitit-web-python-sdk-2.1.0.tar.gz.

File metadata

  • Download URL: splitit-web-python-sdk-2.1.0.tar.gz
  • Upload date:
  • Size: 79.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for splitit-web-python-sdk-2.1.0.tar.gz
Algorithm Hash digest
SHA256 bce3614619615e5b0876a88f64aefd4c3c0dcc97a713805cc6186372f5a8c356
MD5 10d6570813cb9ebdb08568918c69d0d4
BLAKE2b-256 dda0fddefe758e411bcff3eee136e19f9cef1d73f55b2aa0cf59582af908d6c7

See more details on using hashes here.

File details

Details for the file splitit_web_python_sdk-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for splitit_web_python_sdk-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 01968e050b5e9dc728c212b6af7badb916ad4429dd3a8709140643dfac40d162
MD5 3f2e9d12803f5066b0e4b8469d16fd75
BLAKE2b-256 13e0c6bbcdd579fc0f40c1cd658e02677885f510df669b20bfc9c98d41d00a23

See more details on using hashes here.

Supported by

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