Splitit's Web API
- Installation & Usage
- 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
This library requires PHP ^7.0
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/konfig-dev/splitit-web-php-sdk.git"
}
],
"require": {
"konfig/splitit-web-php-sdk": "3.0.9"
}
}
Then run composer install
Download the files and include autoload.php
:
<?php
require_once('/path/to/splitit-web-php-sdk/vendor/autoload.php');
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$splitit = new \Splitit\Client(
getenv("SPLITIT_CLIENT_ID"),
getenv("SPLITIT_CLIENT_SECRET")
);
$result = $splitit->installmentPlan->checkEligibility(
"X-Splitit-IdempotencyKey_example",
"",
[
"total_amount" => 3.14,
"number_of_installments" => 1,
"purchase_method" => "InStore",
"strategy" => "SecuredPlan",
],
[
"card_brand" => "Mastercard",
"card_type" => "Credit",
],
[
],
"string_example"
);
$result = $splitit->installmentPlan->checkEligibility(
"X-Splitit-IdempotencyKey_example",
"",
[
"total_amount" => 3.14,
"number_of_installments" => 1,
"purchase_method" => "InStore",
"strategy" => "SecuredPlan",
],
[
"card_brand" => "Mastercard",
"card_type" => "Credit",
],
[
],
"string_example"
);
TouchPoint
PlanData: PlanData
CardDetails: CardData
BillingAddress: AddressData
InstallmentsEligibilityResponse
/api/installmentplans/check-eligibility
POST
π Back to Table of Contents
$result = $splitit->installmentPlan->get(
"installmentPlanNumber_example",
"X-Splitit-IdempotencyKey_example",
""
);
TouchPoint
/api/installmentplans/{installmentPlanNumber}
GET
π Back to Table of Contents
$result = $splitit->installmentPlan->getEligibilityTermsAndCondition(
"ipn_example",
"X-Splitit-IdempotencyKey_example",
""
);
TouchPoint
EligibilityTermsAndConditionResponse
/api/installmentplans/{ipn}/legal
GET
π Back to Table of Contents
$result = $splitit->installmentPlan->post(
"X-Splitit-IdempotencyKey_example",
"",
True,
True,
[
],
[
"total_amount" => 3.14,
"purchase_method" => "InStore",
],
[
],
[
],
[
],
[
],
[
],
"None",
"SecuredPlan",
"string_example"
);
TouchPoint
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
RedirectUrls: InitiateRedirectionEndpointsModel
UxSettings: UxSettingsModel
EventsEndpoints: EventsEndpointsModel
ProcessingData: ProcessingData
/api/installmentplans/initiate
POST
π Back to Table of Contents
$result = $splitit->installmentPlan->post2(
True,
True,
"X-Splitit-IdempotencyKey_example",
"",
True,
[
],
[
"total_amount" => 3.14,
"purchase_method" => "InStore",
],
[
],
[
"type" => "Card",
],
[
],
[
],
[
],
"None",
"SecuredPlan",
"string_example"
);
TouchPoint
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
PaymentMethod: PaymentMethodModel
RedirectUrls: RedirectionEndpointsModel
ProcessingData: ProcessingData
EventsEndpoints: EventsEndpointsModel
/api/installmentplans
POST
π Back to Table of Contents
$result = $splitit->installmentPlan->refund(
3.14,
"installmentPlanNumber_example",
"X-Splitit-IdempotencyKey_example",
"",
"FutureInstallmentsFirst",
"string_example"
);
TouchPoint
/api/installmentplans/{installmentPlanNumber}/refund
POST
π Back to Table of Contents
$result = $splitit->installmentPlan->search(
"X-Splitit-IdempotencyKey_example",
"",
"string_example",
"string_example",
[
"key": "string_example",
]
);
TouchPoint
/api/installmentplans/search
GET
π Back to Table of Contents
$result = $splitit->installmentPlan->updateOrder(
"installmentPlanNumber_example",
"X-Splitit-IdempotencyKey_example",
"",
"string_example",
"string_example",
True,
"Pending",
3.14
);
TouchPoint
/api/installmentplans/{installmentPlanNumber}/updateorder
PUT
π Back to Table of Contents
$result = $splitit->installmentPlan->updateOrder2(
"X-Splitit-IdempotencyKey_example",
"",
"string_example",
"string_example",
True,
"Pending",
3.14,
[
]
);
TouchPoint
Identifier: IdentifierContract
/api/installmentplans/updateorder
PUT
π Back to Table of Contents
$result = $splitit->installmentPlan->verifyAuthorization(
"installmentPlanNumber_example",
"X-Splitit-IdempotencyKey_example",
""
);
TouchPoint
/api/installmentplans/{installmentPlanNumber}/verifyauthorization
GET
π Back to Table of Contents
This PHP package is automatically generated by Konfig