Generate signature request link for merchant processing agreement

This method allows secure and convenient generation of the MPA, essential for ensuring merchant compliance with the payment processor's terms and conditions.

API Method: POST /api/v1/merchant/requestSignature

Description:

This API endpoint is used to generate a signature request link for a merchant who is in the process of onboarding for payment processing services. The signature request link allows the merchant to sign a Merchant Processing Agreement (MPA) digitally.

Request:

Endpoint:
POST /api/v1/merchant/requestSignature

Purpose:
Generate a unique URL where the merchant can digitally sign the Merchant Processing Agreement (MPA).

Use Case:
This endpoint is typically called after the merchant has completed other necessary steps in the onboarding process (such as providing required documentation). The signature request link ensures that the agreement is signed digitally before proceeding with activating the merchant's payment processing services.

Request Headers:

• Content-Type: application/json
• Authorization: Basic {token}

Request Body:

The body must contain information identifying the merchant and potentially details about the specific agreement or request.

{
  "merchantId": "string",    // Unique identifier for the merchant
  "agreementType": "string", // Type of agreement to be signed (optional)
  "callbackUrl": "string"    // URL where signature updates will be sent
}

• merchantId (required): The unique identifier of the merchant.
• agreementType (optional): Specifies the type of agreement the merchant needs to sign (e.g., "standard" or "custom").
• callbackUrl (optional): The URL to send updates on the status of the signature (e.g., success, failure).

Response:

The response contains the generated signature link along with a success message.

Success Response:

{
  "status": "success",
  "message": "Signature request link generated successfully.",
  "signatureLink": "https://example.com/signature/{uniqueId}"
}

• status: Indicates the success of the request.
• message: A description of the outcome.
• signatureLink: The unique URL where the merchant can review and sign the Merchant Processing Agreement.

Error Responses:

Possible error responses if the request is invalid or cannot be fulfilled.

Example Error:

{
  "status": "error",
  "message": "Merchant ID not found."
}

• status: Indicates the error type.
• message: Provides details about the error.

Security:

The endpoint requires authentication via Bearer Token in the header, ensuring only authorized clients can generate the signature request link.

Example Use Case:

A merchant has completed all necessary documentation, and the payment service provider needs them to sign a Merchant Processing Agreement before proceeding with setting up their account. The provider uses this endpoint to generate the signature request link, which is then sent to the merchant via email or displayed in a user interface.

This API facilitates the final step in the merchant onboarding process by enabling electronic agreement signing, streamlining the flow of merchant account setup for payment processing services.