3. Will the Generic Connector API requests contain everything needed for the Connector Plugin?
Typically, yes. However, there might be cases upon your deeper understanding of the Connector's documentation that some additional parameters are required. In this case, as soon as you are aware, you will need to liase with the Apaya team so Apaya can make the necessary updates.
4. Are there some Special header keys?
Typically, Connectors require API keys. These will be preconfigured and passed to the Plugin via calls available in the Apaya Core Connectors package. see the Connector's documentation.
Upon deeper understanding of the Connector's documentation, you may become aware of other key parameters that should be also passed in via a preconfigured way. In this case, as soon as you are aware, you will need to liaise with the Apaya team so Apaya can make the necessary updates.
5. How will I know which Configuration types to cater for?
Provider, Merchant, and Product configurations can be setup, and they should be thought of in this order.
The Connector plugin will not come into contact with mapping data in the Apaya environment, it will only come into contact with the parameters/values passed into it via these configurations, which the plugin will utilise to make the calls to the third-party Connector.
Note: Apaya will setup this configuration in the Apaya environment, and provide you with sufficient details so that you can implement it in the Connector plugin.
Provider configuration is always required.
However it relates to the Payment Provider which can affect multiple Connectors, so it may already be configured due to a previously integrated Connector, and therefore not needed to be configured again.
This should be discussed in conjunction with the Apaya team.
Merchant configuration is always required.
This is the configuration in the Apaya environment which enables us to pass through Merchant-specific details to the Connector, to ensure that we can act as the conduit between the two entities. This can be a single or multiple parameters depending on the Connector.
Product configuration is only sometimes required.
This is configuration at an Apaya product level where the Connector requires specific information to be passed through on a product/service/skew basis. This is not typically the case, but you will have to ascertain this by reviewing the Connector’s documentation.
Examples of the above:
Provider-specific information may need configuring in the Apaya platform due to specific network code being required in the Connector’s environment relating to a mobile network operator.
Merchant-specific information may need configuring as the Connector requires a MerchantID and MerchantReference to be passed in when making API calls to identify the merchant, so in this case there are 2 merchant configuration parameters.
Product-specific information may need configuring as the Connector requires a specific ID, e.g. a ProductID from their Merchant when performing an API call, so the Connector can identify the product in their environment. Therefore there will be 1 product configuration parameter.
6. Contact support?
For any questions or clarification, please contact support@apaya.io
Want to print your doc? This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
