Connector Plugin - Build Overview

Following the flow diagram in

Appendix E⁠

you will build a connector plugin based off the implementation of the core connector library, see the core library and Plugin example installation section below.

Using this core library you will implement the relevant actions as requested by Apaya for the specific connector interactions required (payment, refund etc.), see the

Available Actions⁠

and Implementation sections below.

The specific connector integration may require various configurations based at a merchant level, such as API header keys, or product/provider mappings. More details on how these are set and used is in the

configuration⁠

section below.

Standard error exceptions can be found in the

Exceptions⁠

section below.

Any inbound webhook notifications for asynchronous type flows or where certain connector integrations require it can be found in the

Webhook⁠

section below.

Once complete along with any testing, the plugin should be packaged up and deployed to the Nuget org site detailed under the

installation⁠

section. Source code and documentation should also be provided.

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.