| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Signed MPA
Retrieves the signed copy of the Merchant Processing Agreement (MPA) for a merchant. The document is returned as a Base64-encoded byte array (file field) inside the standard API response envelope. This endpoint should only be called after the merchant has successfully completed the signing process, which can be confirmed via getSignatureStatus.
Endpoint
GET /api/v1/merchant/getSignedMPA
Authentication
Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:
Authorization: Basic {base64(username:password)}
When to use
Use this endpoint after the merchant's signature status is confirmed as completed (via GET /api/v1/merchant/getSignatureStatus). The signed MPA should be archived for compliance and record-keeping purposes. It may also be sent to the merchant as a confirmation copy.
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 MerchantSignedMPAResponse.
| Field | Type | Description |
|---|---|---|
| data | object | Wrapper for the signed MPA response |
| data.file | string (byte) | Base64-encoded binary content of the signed MPA PDF |
| 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 |
{
"data": {
"file": "JVBERi0xLjQKJeLjz9MKMSAwIG9iagoy..."
},
"status": "OK",
"error": null,
"warning": null,
"validationResults": [],
"requestId": 94712
}To use the PDF, decode data.file from Base64 to binary bytes and write the result to a .pdf file.
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 signed MPA found for the given id — the merchant may not have completed signing yet |
| 500 | Internal server error |
Common Mistakes
- Calling this endpoint before the signing process is complete — check
getSignatureStatusfirst; if the status is not"Completed", no signed document will be available. - Confusing
data.file(Base64-encoded binary) withdata.base64Pdffrom thegenerateMPAPDFendpoint — these are the same encoding format but represent unsigned vs. signed documents respectively. - Attempting to render
data.filedirectly as text — it must be Base64-decoded to binary before it can be opened as a PDF. - Storing the raw API response JSON instead of the decoded PDF bytes for archival purposes.
Related Endpoints
GET /api/v1/merchant/getSignatureStatus— check whether the merchant has completed signingGET /api/v1/merchant/generateMPAPDF— generate the unsigned MPA PDF for review before signingPOST /api/v1/merchant/requestSignature— initiate the signing request for a merchant
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/getSignedMPA?id=10045" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Accept: application/json"