TransferZero.Sdk 1.0.0

TransferZero.Sdk - the C# library for the TransferZero API

TransferZero API

• API version: 1.0

Reference documentation for the TransferZero API V1

For more information, please visit:

• API Documentation
  • Onboarding guide
  • Transaction flow
  • Additional features
• API Specification

This .NET SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks supported

• .NET 4.5 or later
• .NET Core >=2.0

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 10.0.3 or later
• JsonSubTypes - 1.2.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

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

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

using TransferZero.Sdk.Api;
using TransferZero.Sdk.Client;
using TransferZero.Sdk.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out TransferZero.Sdk.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

Please follow the installation instruction.

You can find examples in the examples directory on the features required by the Onboarding documentation for the following languages:

• C# on .NET 4.5
• VB.NET on .NET 4.5
• C# on .NET Core 2.0

Webhooks

To parse webhooks you can use the following snippet:

C#

string webhookContent = "<data from webhook>";

string url = "<url of the webhook endpoint>";

Dictionary<string, string> headers = new Dictionary<string, string>();
headers.Add("Authorization-Nonce", "<nonce from webhook headers>");
headers.Add("Authorization-Signature", "<signature from webhook headerse>");
headers.Add("Authorization-Key", "<key from webhook headers>");

if (configuration.ValidWebhookRequest(url, webhookContent, headers)) {
    Webhook webhook = configuration.ParseString<Webhook>(webhookContent);

    if (webhook.Event.StartsWith("transaction"))
    {
        TransactionWebhook transactionWebhook = configuration.ParseString<TransactionWebhook>(webhookContent);
        System.Console.WriteLine(transactionWebhook);
    }
    else if (webhook.Event.StartsWith("recipient"))
    {
        RecipientWebhook recipientWebhook = configuration.ParseString<RecipientWebhook>(webhookContent);
        System.Console.WriteLine(recipientWebhook);
    }
    else if (webhook.Event.StartsWith("sender"))
    {
        SenderWebhook senderWebhook = configuration.ParseString<SenderWebhook>(webhookContent);
        System.Console.WriteLine(senderWebhook);
    }
    else if (webhook.Event.StartsWith("document"))
    {
        DocumentWebhook documentWebhook = configuration.ParseString<DocumentWebhook>(webhookContent);
        System.Console.WriteLine(documentWebhook);
    }
    else if (webhook.Event.StartsWith("payout_method"))
    {
        PayoutMethodWebhook payoutMethodWebhook = configuration.ParseString<PayoutMethodWebhook>(webhookContent);
        System.Console.WriteLine(payoutMethodWebhook);
    }
}

VB.NET

Dim webhookContent As String = "{<data from webhook>}"

Dim url As String = "<url of webhook request>"
Dim headers As Dictionary(Of String, String) = New Dictionary(Of String, String)()

headers.Add("Authorization-Nonce", "<nonce from webhook headers>")
headers.Add("Authorization-Signature", "<signature from webhook headers>")
headers.Add("Authorization-Key", "<key from webhook headers>")

If configuration.ValidWebhookRequest(url, webhookContent, headers) Then
    Dim webhook As Webhook = configuration.ParseString(Of Webhook)(webhookContent)

    If webhook.[Event].StartsWith("transaction") Then
        Dim transactionWebhook As TransactionWebhook = configuration.ParseString(Of TransactionWebhook)(webhookContent)
        System.Console.WriteLine(transactionWebhook)
    ElseIf webhook.[Event].StartsWith("recipient") Then
        Dim recipientWebhook As RecipientWebhook = configuration.ParseString(Of RecipientWebhook)(webhookContent)
        System.Console.WriteLine(recipientWebhook)
    ElseIf webhook.[Event].StartsWith("sender") Then
        Dim senderWebhook As SenderWebhook = configuration.ParseString(Of SenderWebhook)(webhookContent)
        System.Console.WriteLine(senderWebhook)
    ElseIf webhook.[Event].StartsWith("document") Then
        Dim documentWebhook As DocumentWebhook = configuration.ParseString(Of DocumentWebhook)(webhookContent)
        System.Console.WriteLine(documentWebhook)
    ElseIf webhook.[Event].StartsWith("payout_method") Then
        Dim payoutMethodWebhook As PayoutMethodWebhook = configuration.ParseString(Of PayoutMethodWebhook)(webhookContent)
        System.Console.WriteLine(payoutMethodWebhook)
    End If
End If

Documentation for Authorization

You can set the API Key and Secret on the Configuration object for authentication:

C#

Configuration configuration = new Configuration();
configuration.ApiKey = "<key>";
configuration.ApiSecret = "<secret>";
configuration.BasePath = "https://api-sandbox.transferzero.com/v1";

VB.NET

Dim configuration As Configuration = New Configuration()
configuration.ApiKey = "<key>"
configuration.ApiSecret = "<secret>"
configuration.BasePath = "https://api-sandbox.transferzero.com/v1"