Skip to main content

Get Started

This page provides all the steps needed to create your first extension. It covers the following tasks:

  1. Create Payment Extension in Fynd Commerce
  2. Install Fynd Development Kit Command-line Interface (FDK-CLI)
  3. Download the boilerplate
  4. Populate test data
  5. Preview your extension

Prerequisite​

Before getting started, you'll need the following:

Steps to create a Development Company
  1. Go to Fynd Partners↗.
  2. Login to the Fynd Partners.
  3. Select a suitable organization.
  4. In the left pane, click Companies and go to Development tab.
  5. Click Add.
  6. Fill in the required details.
  7. Click Save. Your account is created and will be available in the development company page.
  8. Click the required development company from the listing page. You will be redirected to the development company in the Fynd Commerce.

1. Create Payment Extension in Fynd Commerce​

  1. Login Fynd Partners portals.
  2. Click Create Extension. A form will appear where you need to provide details for your payment extension. Ensure you fill out all the necessary fields:
  3. Fill in the following details:
    1. Extension Name: Enter a name for your extension
    2. Extension Type: Select Payment from the extension type dropdown.
  4. Click Create. The Payment extension will be crated.
  5. Go to Extension tab and click on the extension you have created.
  6. Navigate to Extension Setup section and click Edit.
  7. You can update the following details:
    1. Distribution Method: The payment extension distribution type is set to Private by default.
    2. Basic Details:
      1. Extension Name
      2. Contact Email: Provide an email address through which Fynd can reach you in case of urgent issues with your extension.
      3. Logo: Upload a logo that represents your extension.
      4. Description: Write a brief description of your payment extension’s functionality.
    3. Extension URL:
      1. The Extension URL is the server URL where your extension is hosted. The Fynd Commerce uses this URL to communicate with your extension.
      2. Refer to Setup Local Development Environment to generate URL and add the same here.
    4. Permissions:
      1. The required permissions for your payment extension are assigned automatically. However, if additional permissions are needed, you can request them by toggling the Request Additional Permissions option. This will allow your extension to interact with other Fynd Commerce APIs.
    5. Refund Capability:
      1. Clear Return to Source supported box and Allow Refunds box if your PG extension does not support refunds to the original payment method.

2. Install FDK CLI​

The FDK CLI simplifies theme and extension development using commands for creating, testing, and deploying projects. For more details, refer to the GitHub documentations↗.

  • Run the following command in your terminal to install FDK CLI:
npm install -g @gofynd/fdk-cli
note

You can run fdk --version to check if FDK CLI is successfully installed.


3. Download the Boilerplate​

We have developed a Boilerplate code that serves as a foundation for creating a Payment Extension. Download the Payments Boilerplate code from Here or use the following command:

git clone --branch extension_boilerplate_v1_it https://github.com/gofynd/payment-extension-boilerplate.git

4. Populate Test Data​

  1. Run the following command to navigate to the extension directory:
cd "extension-name"
  1. Run the following command:
fdk populate
  1. Select your development company.
note

The fdk populate command adds a predefined set of products to the selected development company. This can be done only once per development company. However, if preferred, you can also create the products manually.

5. Preview Your Extension​

  1. Run the following command:
fdk extension preview
  1. Copy the preview URL from your terminal into the browser.
  1. Click Accept and Continue.
🏆 Congratulations!

You've successfully created and launched your first extension.


Next Steps​

Explore the Extension Development Guide to understand the how Boilerplate code works.


Was this section helpful?