Retrieve signature request status

A payment service provider uses this API to check the progress of a merchant's onboarding. After the signature request is initiated, they can poll this API to know whether the merchant has completed signing the required documents or if further action is required.

API Method: GET /api/v1/merchant/getSignatureStatus

Description:
This API method retrieves the current status of a merchant's signature request in the payment processing service. The signature request status is essential to track the progress of the merchant boarding process, ensuring that all necessary agreements or contracts have been signed.

Endpoint: GET /api/v1/merchant/getSignatureStatus

Request Parameters:

1. merchantId (required, string):
   Unique identifier for the merchant whose signature request status is being retrieved.

Response:

• 200 OK: The request was successful, and the response contains the signature request status.
• 400 Bad Request: The request parameters are missing or invalid (e.g., merchantId is not provided).
• 404 Not Found: The specified merchant or signature request was not found.
• 500 Internal Server Error: An error occurred on the server.

Response Body:

{
  "merchantId": "string",
  "requestId": "string",
  "signatureStatus": "string", // Possible values: "Pending", "Completed", "Declined", "Expired"
  "createdAt": "string", // Timestamp when the request was created
  "updatedAt": "string", // Timestamp when the request was last updated
  "expiresAt": "string"  // Timestamp when the request will expire (if applicable)
}

Signature Status Values:

• Pending: The signature request has been created but has not yet been signed by the merchant.
• Completed: The merchant has successfully signed the document.
• Declined: The merchant has declined to sign the document.
• Expired: The signature request has expired and is no longer valid.

Example Request:

GET /api/v1/merchant/getSignatureStatus?merchantId=12345

Example Response:

{
  "merchantId": "12345",
  "requestId": "67890",
  "signatureStatus": "Completed",
  "createdAt": "2023-09-01T12:34:56Z",
  "updatedAt": "2023-09-02T08:00:00Z",
  "expiresAt": "2023-09-10T12:34:56Z"
}

Notes:

• Ensure that the merchantId provided is valid and registered within the payment processing system.
• The response includes timestamps for when the request was created, last updated, and when it expires (if applicable), allowing you to monitor the request's lifecycle.

This endpoint helps monitor the progress of merchant onboarding by tracking the signature request status, which is critical for compliance and activation in the payment processing system.