Installation & Activation Readiness

To implement the activation flow of your Payment extension on Fynd Commerce, you will need to develop the following APIs:

1. Verify Credentials

The getActivationReadiness API verifies the aggregator’s credentials and ensures that the aggregator is ready for payment processing confirming that all necessary configurations and integrations are in place for the seller to process payments.

• Endpoint: GET/api/v1/secrets/{app_id}

Request Parameters

Parameter	Type	Description	Required
app_id	string	Unique application ID of the sales channel	Yes

Response Structure

Parameter	Type	Description	Required
application_id	string	The Application ID of the sales channel	Yes
success	boolean	Indicates whether the API call was successful	Yes
is_active	boolean	Indicates whether the payment extension is activated	Yes
data	array	(Currently unused) Empty array; to be removed in future releases	Yes

Response

In the below given example response, when the getActivationReadiness API is called, it returns a response indicating whether the extension is properly configured and ready for activation. A success status confirms that the validation process was completed without issues, and the is_active flag indicates if the payment extension is active and ready for transactions.

{
  "application_id": "0000001",
  "success": true,
  "is_active": true,
  "data": []
}

2. Retrieve Form

The getCredentialFields API is called to retrieve the form fields the seller needs to input their payment gateway credentials.

• Endpoint: GET/credentials/:app_id

3. Store Credentials

The setCredentials API stores the seller’s credentials in the extension's database. Once stored, the extension is available for the seller to configure and activate.

• Endpoint: POST/credentials/:app_id