Splitit.Onboarding.Net 3.0.0

Splitit.Onboarding.Net - the C# library for the Splitit.OnBoarding.Api.V2

Splitit's Onboarding API

This C# SDK is automatically generated by the Konfig:

• API version: 1.0.0
• SDK version: 3.0.0

<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.Onboarding.Net.Api;
using Splitit.Onboarding.Net.Client;
using Splitit.Onboarding.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.Onboarding.Net.Api;
using Splitit.Onboarding.Net.Client;
using Splitit.Onboarding.Net.Model;

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

            Configuration config = new Configuration();

            // Configure custom BasePath if desired
            // config.BasePath = "https://onboarding-v2.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 DataApi(config);

            try
            {
                CountriesResponse result = apiInstance.GetCountries();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DataApi.GetCountries: " + 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://onboarding-v2.sandbox.splitit.com

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

Documentation for Models

• Model.CountriesResponse
• Model.CountryResponse
• Model.CreateDeveloperRequest
• Model.CreateMerchantRequest
• Model.CreateMerchantResponse
• Model.CurrenciesResponse
• Model.CurrencyResponse
• Model.EnumDTO
• Model.Error
• Model.GetMerchantDetailsResponse
• Model.GetMerchantResponse
• Model.GetMerchantsResponse
• Model.MerchantVerticalResponse
• Model.MerchantVerticalsResponse
• Model.ProcessorAuthenticationParametersRequest
• Model.ProcessorResponse
• Model.ProcessorsResponse
• Model.RequestHeaderSlim
• Model.ResponseHeader
• Model.SelfOnBoardingErrorResponse

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

Documentation for Authorization

<a name="oauth2"></a>

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • onboarding.api.v2: onboarding.api.v2