Splitit's Web API
- 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
npm |
pnpm |
yarn |
---|---|---|
npm i splitit-web-typescript-sdk |
pnpm i splitit-web-typescript-sdk |
yarn add splitit-web-typescript-sdk |
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);
const checkEligibilityResponse = await splitit.installmentplan.checkEligibility(
{
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
}
);
TouchPoint
PlanData: PlanData
CardDetails: CardData
BillingAddress: AddressData
InstallmentsEligibilityResponse
/api/installmentplans/check-eligibility
POST
const getResponse = await splitit.installmentplan.get({
installmentPlanNumber: "installmentPlanNumber_example",
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
});
TouchPoint
/api/installmentplans/{installmentPlanNumber}
GET
const getEligibilityTermsAndConditionResponse =
await splitit.installmentplan.getEligibilityTermsAndCondition({
ipn: "ipn_example",
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
});
TouchPoint
EligibilityTermsAndConditionResponse
/api/installmentplans/{ipn}/legal
GET
const postResponse = await splitit.installmentplan.post({
xSplititTestMode: "None",
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
});
TouchPoint
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
RedirectUrls: InitiateRedirectionEndpointsModel
UxSettings: UxSettingsModel
EventsEndpoints: EventsEndpointsModel
ProcessingData: ProcessingData
/api/installmentplans/initiate
POST
const post2Response = await splitit.installmentplan.post2({
xSplititTestMode: "None",
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
AutoCapture: true,
TermsAndConditionsAccepted: true,
});
TouchPoint
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
PaymentMethod: PaymentMethodModel
RedirectUrls: RedirectionEndpointsModel
ProcessingData: ProcessingData
EventsEndpoints: EventsEndpointsModel
/api/installmentplans
POST
const refundResponse = await splitit.installmentplan.refund({
installmentPlanNumber: "installmentPlanNumber_example",
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
Amount: 3.14,
RefundStrategy: "FutureInstallmentsFirst",
});
TouchPoint
RefundStrategy: RefundStrategy
/api/installmentplans/{installmentPlanNumber}/refund
POST
const searchResponse = await splitit.installmentplan.search({
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
});
TouchPoint
/api/installmentplans/search
GET
const updateOrderResponse = await splitit.installmentplan.updateOrder({
installmentPlanNumber: "installmentPlanNumber_example",
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
ShippingStatus: "Pending",
});
TouchPoint
ShippingStatus: ShippingStatus
/api/installmentplans/{installmentPlanNumber}/updateorder
PUT
const updateOrder2Response = await splitit.installmentplan.updateOrder2({
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
ShippingStatus: "Pending",
});
TouchPoint
ShippingStatus: ShippingStatus
Identifier: IdentifierContract
/api/installmentplans/updateorder
PUT
const verifyAuthorizationResponse =
await splitit.installmentplan.verifyAuthorization({
installmentPlanNumber: "installmentPlanNumber_example",
xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
xSplititTouchPoint: "",
});
TouchPoint
/api/installmentplans/{installmentPlanNumber}/verifyauthorization
GET
This TypeScript package is automatically generated by Konfig