splitit-web-php-sdk

Splitit's Web API

Installation & Usage
Getting Started
Reference

Installation & Usage

Requirements

This library requires PHP ^7.0

Composer

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.0"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/splitit-web-php-sdk/vendor/autoload.php');

Getting Started

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",
    ], 
    [
        "card_brand" => "Mastercard",
        "card_type" => "Credit",
    ], 
    [
    ], 
    "string_example"
);

Reference

`splitit.installmentPlan.checkEligibility`

🛠️ Usage

$result = $splitit->installmentPlan->checkEligibility(
    "X-Splitit-IdempotencyKey_example", 
    "", 
    [
        "total_amount" => 3.14,
        "number_of_installments" => 1,
        "purchase_method" => "InStore",
    ], 
    [
        "card_brand" => "Mastercard",
        "card_type" => "Credit",
    ], 
    [
    ], 
    "string_example"
);

⚙️ Parameters

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `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

$result = $splitit->installmentPlan->get(
    "installmentPlanNumber_example", 
    "X-Splitit-IdempotencyKey_example", 
    ""
);

⚙️ Parameters

installment_plan_number: `string`

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

🔄 Return

InstallmentPlanGetResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber} GET

🔙 Back to Table of Contents

`splitit.installmentPlan.post`

🛠️ Usage

$result = $splitit->installmentPlan->post(
    True, 
    "X-Splitit-IdempotencyKey_example", 
    "", 
    True, 
    [
    ], 
    [
        "total_amount" => 3.14,
        "purchase_method" => "InStore",
    ], 
    [
    ], 
    [
    ], 
    [
    ], 
    [
    ], 
    [
    ], 
    "None", 
    "string_example"
);

⚙️ Parameters

AutoCapture: `bool`

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

Attempt3dSecure: `bool`

Shopper: `ShopperData`

PlanData: `PlanDataModel`

BillingAddress: `AddressDataModel`

RedirectUrls: `InitiateRedirectionEndpointsModel`

UxSettings: `UxSettingsModel`

EventsEndpoints: `EventsEndpointsModel`

ProcessingData: `ProcessingData`

x_splitit_test_mode: `string`

splititclientinfo: `string`

🔄 Return

InitiatePlanResponse

🌐 Endpoint

/api/installmentplans/initiate POST

🔙 Back to Table of Contents

`splitit.installmentPlan.post2`

🛠️ Usage

$result = $splitit->installmentPlan->post2(
    True, 
    True, 
    "X-Splitit-IdempotencyKey_example", 
    "", 
    True, 
    [
    ], 
    [
        "total_amount" => 3.14,
        "purchase_method" => "InStore",
    ], 
    [
    ], 
    [
        "type" => "Card",
    ], 
    [
    ], 
    [
    ], 
    [
    ], 
    "None", 
    "string_example"
);

⚙️ Parameters

AutoCapture: `bool`

TermsAndConditionsAccepted: `bool`

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

Attempt3dSecure: `bool`

Shopper: `ShopperData`

PlanData: `PlanDataModel`

BillingAddress: `AddressDataModel`

PaymentMethod: `PaymentMethodModel`

RedirectUrls: `RedirectionEndpointsModel`

ProcessingData: `ProcessingData`

EventsEndpoints: `EventsEndpointsModel`

x_splitit_test_mode: `string`

splititclientinfo: `string`

🔄 Return

InstallmentPlanCreateResponse

🌐 Endpoint

/api/installmentplans POST

🔙 Back to Table of Contents

`splitit.installmentPlan.refund`

🛠️ Usage

$result = $splitit->installmentPlan->refund(
    3.14, 
    "installmentPlanNumber_example", 
    "X-Splitit-IdempotencyKey_example", 
    "", 
    "FutureInstallmentsFirst", 
    "string_example"
);

⚙️ Parameters

Amount: `float`

installment_plan_number: `string`

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

RefundStrategy:

ReferenceId: `string`

🔄 Return

InstallmentPlanRefundResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/refund POST

🔙 Back to Table of Contents

`splitit.installmentPlan.search`

🛠️ Usage

$result = $splitit->installmentPlan->search(
    "X-Splitit-IdempotencyKey_example", 
    "", 
    "string_example", 
    "string_example", 
    [
        "key": "string_example",
    ]
);

⚙️ Parameters

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

installment_plan_number: `string`

ref_order_number: `string`

extended_params: array<string, `string`>

🔄 Return

InstallmentPlanSearchResponse

🌐 Endpoint

/api/installmentplans/search GET

🔙 Back to Table of Contents

`splitit.installmentPlan.updateOrder`

🛠️ Usage

$result = $splitit->installmentPlan->updateOrder(
    "installmentPlanNumber_example", 
    "X-Splitit-IdempotencyKey_example", 
    "", 
    "string_example", 
    "string_example", 
    True, 
    "Pending", 
    3.14
);

⚙️ Parameters

installment_plan_number: `string`

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

RefOrderNumber: `string`

TrackingNumber: `string`

Capture: `bool`

ShippingStatus:

NewAmount: `float`

🔄 Return

InstallmentPlanUpdateResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/updateorder PUT

🔙 Back to Table of Contents

`splitit.installmentPlan.updateOrder2`

🛠️ Usage

$result = $splitit->installmentPlan->updateOrder2(
    "X-Splitit-IdempotencyKey_example", 
    "", 
    "string_example", 
    "string_example", 
    True, 
    "Pending", 
    3.14, 
    [
    ]
);

⚙️ Parameters

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

RefOrderNumber: `string`

TrackingNumber: `string`

Capture: `bool`

ShippingStatus:

NewAmount: `float`

Identifier: `IdentifierContract`

🔄 Return

InstallmentPlanUpdateResponse

🌐 Endpoint

/api/installmentplans/updateorder PUT

🔙 Back to Table of Contents

`splitit.installmentPlan.verifyAuthorization`

🛠️ Usage

$result = $splitit->installmentPlan->verifyAuthorization(
    "installmentPlanNumber_example", 
    "X-Splitit-IdempotencyKey_example", 
    ""
);

⚙️ Parameters

installment_plan_number: `string`

x_splitit_idempotency_key: `string`

x_splitit_touch_point: `string`

TouchPoint

🔄 Return

VerifyAuthorizationResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/verifyauthorization GET

🔙 Back to Table of Contents

Author

This PHP package is automatically generated by Konfig

konfig-dev / splitit-web-php-sdk Goto Github PK