Apaya.Connector.Template 1.0.1

Requires NuGet 3.3.0 or higher.

dotnet add package Apaya.Connector.Template --version 1.0.1
NuGet\Install-Package Apaya.Connector.Template -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Apaya.Connector.Template" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Apaya.Connector.Template --version 1.0.1
#r "nuget: Apaya.Connector.Template, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Apaya.Connector.Template as a Cake Addin
#addin nuget:?package=Apaya.Connector.Template&version=1.0.1

// Install Apaya.Connector.Template as a Cake Tool
#tool nuget:?package=Apaya.Connector.Template&version=1.0.1

Introduction

Apaya is a payments Orchestration platform linking Merchants to multiple payment providers through one link. This code template example is to be used by third party connectors or developers to aid development of connector integrations between Apaya and third party Payment Providers.

This Example Template solution includes the following:

  1. Connector Template Project
  2. Connector Test Project

The Connector Template Project is an example of a connector plugin that enables Apayas generic connector API to link / integrate into a specific connectors API. You can use this example to develope specific plugins for specific Connectors.

The Connector Test Project is an example test harness to enable you to test your logic / connections to the specific connector.

Getting Started

  1. Create a copy of this solution and rename files where appropriate to the specific connector you are coding.
  2. Within the Connector Template Project, specific configuration keys will be required so the main TemplatePlugin file would change to include all the specific required keys (e.g. apiKey, Password etc) and also to set the name of your connector plugin.
  3. Change TemplatePlugin name to the specific connector/provider name → ConnectorPlugin.
  4. The Models folder holds all the various request/response payload schemas, and is a key area you would change to match the schemas of the specific connector being developed.
  5. Within the Test Project, amend the example data values (as likely to need changing) to match test runs that you do to the connector. Especially when checking / updating previous transactions, the relevant ids would need to match.
  6. Once tested and happy it works, package up the build and source code and send to us.

Build and Test

Build your amended version of these C# projects and test your integration.

Contribute

Please use this example as the starting point to develope connector integrations between Apaya and third party payment providers.

Contact Apaya for more details. support@apaya.io.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 276 9/21/2023