Install the extension and configure the gateway

Once you create the extension, you need to install it and configure the payment gateway.

Install the extension

To install the extension, do the following in the administration interface:

  1. Click the Settings icon.
  2. Click Extensions and display the Developer tab.
  3. Click Generate ID. In the dialog, fill in the extension name and click Save. A new extension ID is created.
  4. Set the extensionID property in the ext.json file to the value of the ID.
  5. Package the extension in a ZIP file. (See Create a credit card extension.)
  6. In the Installed tab, click Upload Extension. Select the ZIP file.

Once the extension is uploaded, it appears in the list of installed extensions.

Enable the gateway

To enable the new payment gateway:

  1. Click the Settings icon.
  2. Select the site you want to configure the gateway for.
  3. Click Payment Processing and display the Payment Gateways tab.
  4. Select the payment gateway integration you installed from the Service Type drop-down list.
  5. Select the Payment Gateway Enabled checkbox.
  6. Configure any other settings required by the integration. For example, in the extension shown in Create a credit card extension, there are checkboxes for enabling credit card support under Preview Configuration, Agent Configuration, and Storefront Configuration.

When you enable a custom credit card payment gateway for a site, make sure that the other credit card gateways (for example, CyberSource and Chase Paymentech Credit Cards) are disabled on that site. Only one credit card gateway integration should be enabled for an individual site.

Configure the Credit Card Payment webhook

When you create an integration for a credit card gateway, the integration uses the Credit Card Payment webhook to send authorization requests to the gateway. To configure the webhook:

  1. Click the Settings icon.
  2. Click Web APIs and display the Webhook tab.
  3. Select the Credit Card Payment webhook that you want to configure. Note that there are separate Preview and Production versions of the webhook.
  4. In the URL field, enter the URL for accessing the payment gateway. The URL must use HTTPS.
  5. Under Basic Authorization, fill in the username and password for accessing your gateway account.
  6. If your gateway requires any additional HTTP request headers, click Add New Header Property and fill in the property name and value.
  7. Click Save.

Note that webhook settings are not site-specific. The configuration you supply applies to all sites that use this webhook.