Splitit.Web.Net 1.0.8

Splitit.Web.Net - the C# library for the splitit-web-api-v3

Splitit's API

This C# SDK is automatically generated by the Konfig:

• API version: 1.0.0
• SDK version: 1.0.8

<a name="frameworks-supported"></a>

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

<a name="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.1 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Splitit.Web.Net.Api;
using Splitit.Web.Net.Client;
using Splitit.Web.Net.Model;

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Splitit.Web.Net.Api;
using Splitit.Web.Net.Client;
using Splitit.Web.Net.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();

            // Configure custom BasePath if desired
            // config.BasePath = "https://web-api-v3.sandbox.splitit.com";

            // Configure OAuth2 credentials for "application" OAuth flow
            string clientId = System.Environment.GetEnvironmentVariable("CLIENT_ID");
            string clientSecret = System.Environment.GetEnvironmentVariable("CLIENT_SECRET");
            config.OAuthClientId = clientId;
            config.OAuthClientSecret = clientSecret;

            var apiInstance = new InstallmentPlanApi(config);
            var installmentPlanNumber = "installmentPlanNumber_example";  // string | 
            var xSplititIdempotencyKey = "xSplititIdempotencyKey_example";  // string | 

            try
            {
                InstallmentPlanCancelResponse result = apiInstance.Cancel(installmentPlanNumber, xSplititIdempotencyKey);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InstallmentPlanApi.Cancel: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://web-api-v3.sandbox.splitit.com

<a name="documentation-for-models"></a>

Documentation for Models

• Model.AddressData
• Model.AddressDataModel
• Model.AuthorizationModel
• Model.CardData
• Model.Error
• Model.ErrorExtended
• Model.ErrorExtendedAllOf
• Model.FailedResponse
• Model.FailedResponseAllOf
• Model.GwAuthorizationStatus
• Model.IdentifierContract
• Model.Installment
• Model.InstallmentPlanCancelResponse
• Model.InstallmentPlanCreateRequest
• Model.InstallmentPlanGetResponse
• Model.InstallmentPlanGetResponseAllOf
• Model.InstallmentPlanModel
• Model.InstallmentPlanModelAllOf
• Model.InstallmentPlanRefundRequest
• Model.InstallmentPlanRefundResponse
• Model.InstallmentPlanRefundResponseAllOf
• Model.InstallmentPlanUpdateRequest
• Model.InstallmentPlanUpdateRequestByIdentifier
• Model.InstallmentPlanUpdateRequestByIdentifierAllOf
• Model.InstallmentPlanUpdateResponse
• Model.InstallmentPlanUpdateResponseAllOf
• Model.InstallmentStatus
• Model.LinksData
• Model.PaymentMethodModel
• Model.PaymentMethodType
• Model.PlanDataModel
• Model.PlanErrorResponse
• Model.PlanErrorResponseAllOf
• Model.PlanStatus
• Model.PurchaseMethod
• Model.RedirectionEndpointsModel
• Model.RefundStrategy
• Model.RefundSummary
• Model.ShippingStatus
• Model.ShippingStatus2
• Model.ShopperData
• Model.TestModes
• Model.ThreeDsRedirectData
• Model.UpdateOrderRequest
• Model.VerifyAuthorizationResponse
• Model.VerifyAuthorizationResponseAllOf

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="bearer"></a>

bearer

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • api.v3: