splitit-web-typescript-sdk v4.0.8

splitit-web-typescript-sdk

Splitit's Web API

Table of Contents

• Installation
• Getting Started
• Reference
  • splitit.installmentplan.checkEligibility
  • splitit.installmentplan.get
  • splitit.installmentplan.getEligibilityTermsAndCondition
  • splitit.installmentplan.post
  • splitit.installmentplan.post2
  • splitit.installmentplan.refund
  • splitit.installmentplan.search
  • splitit.installmentplan.updateOrder
  • splitit.installmentplan.updateOrder2
  • splitit.installmentplan.verifyAuthorization

Installation

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.getEligibilityTermsAndCondition

🛠️ Usage

const getEligibilityTermsAndConditionResponse =
  await splitit.installmentplan.getEligibilityTermsAndCondition({
    ipn: "ipn_example",
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  });

⚙️ Parameters

ipn: string

xSplititIdempotencyKey: string

xSplititTouchPoint: string

TouchPoint

🔄 Return

EligibilityTermsAndConditionResponse

🌐 Endpoint

/api/installmentplans/{ipn}/legal GET

🔙 Back to Table of Contents

splitit.installmentplan.post

🛠️ Usage

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

⚙️ Parameters

xSplititIdempotencyKey: string

xSplititTouchPoint: string

TouchPoint

AutoCapture: boolean

Attempt3dSecure: boolean

Shopper: ShopperData

PlanData: PlanDataModel

BillingAddress: AddressDataModel

RedirectUrls: InitiateRedirectionEndpointsModel

UxSettings: UxSettingsModel

EventsEndpoints: EventsEndpointsModel

ProcessingData: ProcessingData

xSplititTestMode: 'None' | 'Regular' | 'Fast' | 'Automation'

xSplititStrategy: 'SecuredPlan' | 'NonSecuredPlan' | 'SecuredPlanCaptureExistingSecurityAuth' | 'SecuredPlan3' | 'SinglePayment' | 'ExternalInstallmentProvider' | 'SecuredPlan3A' | 'SecuredPlan3B' | 'SecuredPlan2A' | 'SecuredPlan2' | 'SecuredPlan4' | 'SecuredPlan4A'

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",
  xSplititStrategy: "SecuredPlan",
  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

RedirectUrls: RedirectionEndpointsModel

ProcessingData: ProcessingData

EventsEndpoints: EventsEndpointsModel

xSplititTestMode: 'None' | 'Regular' | 'Fast' | 'Automation'

xSplititStrategy: 'SecuredPlan' | 'NonSecuredPlan' | 'SecuredPlanCaptureExistingSecurityAuth' | 'SecuredPlan3' | 'SinglePayment' | 'ExternalInstallmentProvider' | 'SecuredPlan3A' | 'SecuredPlan3B' | 'SecuredPlan2A' | 'SecuredPlan2' | 'SecuredPlan4' | 'SecuredPlan4A'

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