Payment Extension Installation
Before proceeding with the installation, the Fynd Commerce verifies whether the extension is already installed for the seller. If it is not installed, the seller is redirected to the OAuth handshake page, where they must approve the installation.
We recommend using one of our Extension helper libraries (JavaScript) to keep your Extension secure, avoid implementing OAuth, and focus on core logic.
Do the following steps to install a payment extension:
- Login to Fynd Commerce.
- Navigate to Sales Channel > Settings > Payments > Payment Configuration.
- Click Add Payment Gateway. A list of available payment extensions is displayed, allowing the seller to choose the desired PG for integration.
- Navigate to the desired payment extension and click Install.
The Fynd Commerce triggers a call to the extension’s /fp/install endpoint. The extension then generates an OAuth handshake URL, calls the platform’s /fp/auth API, and redirects the seller to this URL. If an application_id
is included in the install/open request, it must be appended as a query parameter in the redirect URL within the OAuth handshake URL. This ensures that the extension can identify the application_id
during the OAuth callback.
After the seller accepts the permissions, the extension is installed at the Sales-channel level, and the seller is redirected to the extension’s default URL. At this stage, the extension’s status is updated to Ready for Activation on the Fynd Commerce.
After redirection, the Credentials Form is displayed, and the Credentials API is called to retrieve the necessary fields for the seller to enter their PG credentials. The seller is then presented with a form where they can input the required details. Once the seller submits the credentials, Fynd Commerce calls the extension’s Credential POST API to securely store the provided details.
After successful credential storage, the extension is marked as Ready for Configuration on the Fynd Commerce. The seller can now activate and configure the extension based on their business requirements.