| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retrieve Signature Request Status
Returns the current signing status for a merchant's Merchant Processing Agreement (MPA). After initiating a signature request, poll this endpoint to determine whether the merchant has signed, declined, or if the request is still pending or has expired. The signingStatus field contains the current state of the signature workflow.
Endpoint
GET /api/v1/merchant/getSignatureStatus
Authentication
Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:
Authorization: Basic {base64(username:password)}When to use
Poll this endpoint after calling requestSignature to monitor the progress of the merchant's signing. Once the status is "Completed", proceed to getSignedMPA to retrieve the signed document. If the status is "Declined" or "Expired", a new signature request must be initiated.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | The unique internal ID of the merchant application |
Response
200 OK
The data object is of type MerchantSigningStatusResponse.
| Field | Type | Description |
|---|---|---|
| data | object | Wrapper for the signing status payload |
| data.signingStatus | string | Current status of the signature request. Typical values: "Pending", "Completed", "Declined", "Expired" |
| status | string | HTTP status string (e.g., "OK") |
| error | string | Error message if the request failed |
| warning | string | Non-fatal warning message |
| validationResults | array | List of validation errors, each with memberNames and errorMessage |
| requestId | integer (int32) | Internal request tracking ID |
Signing Status Values:
| Value | Meaning |
|---|---|
Pending | The signature request was sent but the merchant has not yet signed |
Completed | The merchant has successfully signed the MPA |
Declined | The merchant explicitly declined to sign the document |
Expired | The signature request window has closed without the merchant signing |
{
"data": {
"signingStatus": "Completed"
},
"status": "OK",
"error": null,
"warning": null,
"validationResults": [],
"requestId": 60311
}Error Codes
| Code | When it happens |
|---|---|
| 400 | The id query parameter is missing or not a valid integer |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No signature request found for the given merchant id |
| 500 | Internal server error |
Common Mistakes
- Calling this endpoint before a signature request has been initiated — no signing record will exist and the endpoint will return 404.
- Polling too aggressively — implement reasonable polling intervals (e.g., every 30–60 seconds) rather than continuous requests.
- Assuming
"Completed"means the signed PDF is immediately available — allow a brief delay before callinggetSignedMPAas document processing may take a moment. - Not handling the
"Expired"or"Declined"states in client logic — these require generating a new MPA and re-initiating the signature request.
Related Endpoints
POST /api/v1/merchant/requestSignature— initiate the signing request for a merchantGET /api/v1/merchant/getSignedMPA— retrieve the completed signed MPA PDF (call after status is"Completed")GET /api/v1/merchant/generateMPAPDF— generate the unsigned MPA PDF
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/getSignatureStatus?id=10045" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Accept: application/json"