splitit-web-typescript-sdk
TypeScript icon, indicating that this package has built-in type declarations

4.0.1 • Public • Published

splitit-web-typescript-sdk

Splitit's Web API

npm

Table of Contents

Installation

npm pnpm yarn
npm i splitit-web-typescript-sdk
pnpm i splitit-web-typescript-sdk
yarn add splitit-web-typescript-sdk

Getting Started

import { Splitit } from "splitit-web-typescript-sdk";

const splitit = new Splitit({
  // Defining the base path is optional and defaults to https://web-api-v3.production.splitit.com
  // basePath: "https://web-api-v3.production.splitit.com",
  oauthClientId: "CLIENT_ID",
  oauthClientSecret: "CLIENT_SECRET",
});

const checkEligibilityResponse = await splitit.installmentplan.checkEligibility(
  {
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  }
);

console.log(checkEligibilityResponse);

Reference

splitit.installmentplan.checkEligibility

🛠️ Usage

const checkEligibilityResponse = await splitit.installmentplan.checkEligibility(
  {
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  }
);

⚙️ Parameters

xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

PlanData: PlanData
CardDetails: CardData
BillingAddress: AddressData
ShopperIdentifier: string

🔄 Return

InstallmentsEligibilityResponse

🌐 Endpoint

/api/installmentplans/check-eligibility POST

🔙 Back to Table of Contents


splitit.installmentplan.get

🛠️ Usage

const getResponse = await splitit.installmentplan.get({
  installmentPlanNumber: "installmentPlanNumber_example",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
});

⚙️ Parameters

installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

🔄 Return

InstallmentPlanGetResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber} GET

🔙 Back to Table of Contents


splitit.installmentplan.post

🛠️ Usage

const postResponse = await splitit.installmentplan.post({
  xSplititTestMode: "None",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  AutoCapture: true,
});

⚙️ Parameters

AutoCapture: boolean
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

Attempt3dSecure: boolean
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
UxSettings: UxSettingsModel
EventsEndpoints: EventsEndpointsModel
ProcessingData: ProcessingData
xSplititTestMode: 'None' | 'Regular' | 'Fast' | 'Automation'
splititclientinfo: string

🔄 Return

InitiatePlanResponse

🌐 Endpoint

/api/installmentplans/initiate POST

🔙 Back to Table of Contents


splitit.installmentplan.post2

🛠️ Usage

const post2Response = await splitit.installmentplan.post2({
  xSplititTestMode: "None",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  AutoCapture: true,
  TermsAndConditionsAccepted: true,
});

⚙️ Parameters

AutoCapture: boolean
TermsAndConditionsAccepted: boolean
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

Attempt3dSecure: boolean
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
PaymentMethod: PaymentMethodModel
ProcessingData: ProcessingData
EventsEndpoints: EventsEndpointsModel
xSplititTestMode: 'None' | 'Regular' | 'Fast' | 'Automation'
splititclientinfo: string

🔄 Return

InstallmentPlanCreateResponse

🌐 Endpoint

/api/installmentplans POST

🔙 Back to Table of Contents


splitit.installmentplan.refund

🛠️ Usage

const refundResponse = await splitit.installmentplan.refund({
  installmentPlanNumber: "installmentPlanNumber_example",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  Amount: 3.14,
  RefundStrategy: "FutureInstallmentsFirst",
});

⚙️ Parameters

Amount: number
installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

RefundStrategy: RefundStrategy
ReferenceId: string

🔄 Return

InstallmentPlanRefundResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/refund POST

🔙 Back to Table of Contents


splitit.installmentplan.search

🛠️ Usage

const searchResponse = await splitit.installmentplan.search({
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
});

⚙️ Parameters

xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

installmentPlanNumber: string
refOrderNumber: string
extendedParams: Record<string, string>

🔄 Return

InstallmentPlanSearchResponse

🌐 Endpoint

/api/installmentplans/search GET

🔙 Back to Table of Contents


splitit.installmentplan.updateOrder

🛠️ Usage

const updateOrderResponse = await splitit.installmentplan.updateOrder({
  installmentPlanNumber: "installmentPlanNumber_example",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  ShippingStatus: "Pending",
});

⚙️ Parameters

installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

RefOrderNumber: string
TrackingNumber: string
Capture: boolean
ShippingStatus: ShippingStatus
NewAmount: number

🔄 Return

InstallmentPlanUpdateResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/updateorder PUT

🔙 Back to Table of Contents


splitit.installmentplan.updateOrder2

🛠️ Usage

const updateOrder2Response = await splitit.installmentplan.updateOrder2({
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  ShippingStatus: "Pending",
});

⚙️ Parameters

xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

RefOrderNumber: string
TrackingNumber: string
Capture: boolean
ShippingStatus: ShippingStatus
NewAmount: number
Identifier: IdentifierContract

🔄 Return

InstallmentPlanUpdateResponse

🌐 Endpoint

/api/installmentplans/updateorder PUT

🔙 Back to Table of Contents


splitit.installmentplan.verifyAuthorization

🛠️ Usage

const verifyAuthorizationResponse =
  await splitit.installmentplan.verifyAuthorization({
    installmentPlanNumber: "installmentPlanNumber_example",
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  });

⚙️ Parameters

installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

🔄 Return

VerifyAuthorizationResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/verifyauthorization GET

🔙 Back to Table of Contents


Author

This TypeScript package is automatically generated by Konfig

Package Sidebar

Install

npm i splitit-web-typescript-sdk

Weekly Downloads

29

Version

4.0.1

License

Unlicense

Unpacked Size

245 kB

Total Files

165

Last publish

Collaborators

  • konfig-publisher