PaymentGatewayBase class has several methods and fields which are required to implement. GetTransactionByResponseData: This method returns a <TransactionResponseDetails> object that includes the information of the transaction based on the response data that comes from the Redirection URL response (Only for redirection methods).
PaymentGatewayBase class has several methods and fields which are required to implement.
GetTransactionByResponseData: This method returns a <TransactionResponseDetails> object that includes the information of the transaction based on the response data that comes from the Redirection URL response (Only for redirection methods).
Payment Gateway Categories
As is mentioned above, interworks.cloud platform supports several payment gateway categories. Read the guidelines for every case:
This category only supports the following flow:
- redirection to the external provider's page
- fill in the credit card details
- redirect back to interworks.cloud platform to complete the transaction and keep the credit card's token.
Required methods to implement
1. It is required to return the RedirectionUrl in PrepareTransactionResponse object of the PrepareTransaction method. Otherwise the redirection will not work! This Url is the gateway's external page
2. If the response data is being sent back to interworks.cloud platfrom in the URL as query string values for example:
you have to implement the GetTransactionByResponseData method that has as input these query string data values.The return url should contain also all the values you need that the method GetTransactionByResponseData
3. Callback Response URL (RedirectionURL)
When the payment is completed the gateway itself has to redirect to the static response handler page which is always:
The gateway has to return the query string values that contain all results and then GetTransactionByResponseData of plugin will analyze the result.IMPORTANT - type=<your_plugin_name> must be exactly with this name pattern.
This category supports client-side form hosted at interworks.cloud platform and there is a js client side bridge between the provider to initialize the form.
Required methods to implement:
You have to provide The UI processor (for example SampleUiProcessor.js) that communicates with the provider's bridge to perform transactions. Read this part for more details and a ready template. This is a PCI Compliant payment gateway category as the form resides on the client's browser. Only the token is being kept for future transactions.Interworks.cloud platform saves only tokenization data to database.
IFrameForm : This category includes payment gateways that serves an iframe for the customer's credit card info. Interwork.cloud platform opens this iframe.
SimpleRedirection: This category includes payment gateways that redirects to the gateway's provider page to fill the the customer's credit card info. Interwork.cloud platform show a button to redirect to the provider's page
TokenizationRedirection: This category includes payment gateways that redirects to the gateway's provider page to fill the the customer's credit card info. After that this category supports a token that represents a credit card. Interwork.cloud platform show a button to redirect to the provider's page and then keeps the token to platform's database for future transactions.
Label: The user-friendly label name of the settings. For example, "Api Username".
Id: The id that will be saved at interworks.cloud platform. For example, "api_username".
Value: The value of the settings.Leave it blank as it will be filled by interorks.cloud platform setup page.
Type: The type of the settings.Text or boolean to represent a text input or a checkbox ui elements at settings page.
Result: A transaction result object.
TransactionPaymentId: This is the PaymentId from the interworks.cloud platform.It is the communicator between interworks.cloud platform and the provider's service.
Amount: The amount of the transaction. It is decimal type and conversions may be needed in plugin's implementation.
CreditCardToken: Represents the credit card token.
ExtraInfo: For some extra string info to pass
RedirectionUrl: The url that interworks.cloud platform will use to redirect.The provider's credit card's info page.
CustomerName: Some providers requires the customer's name.
CustomerEmail: Some providers requires the customer's email
Table of Contents
- No labels