WpSDK 1.0.0

Getting Started with Reporting: Settlement Research API

Introduction

API used to search and retrieve settled transactions. This API is used to search settled transactions and retrieve individual transaction details based on card types.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package WpSDK --version 1.0.0

You can also view the package at: https://www.nuget.org/packages/WpSDK/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using Microsoft.Extensions.Logging;
using ReportingSettlementResearchApi.Standard;
using ReportingSettlementResearchApi.Standard.Authentication;

namespace ConsoleApp;

ReportingSettlementResearchApiClient client = new ReportingSettlementResearchApiClient.Builder()
    .CustomHeaderAuthenticationCredentials(
        new CustomHeaderAuthenticationModel.Builder(
            "Authorization"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using ReportingSettlementResearchApi.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = ReportingSettlementResearchApiClient
    .FromConfiguration(configuration.GetSection("ReportingSettlementResearchApi"));

See the Configuration-Based Initialization section for details.

Authorization

This API uses the following authentication schemes.

• api_key (Custom Header Signature)

List of APIs

• Settlement Errors
• Settlement Daily Totals
• Settlement Batches
• Transaction Type
• Transaction Status
• Settlements

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter