Get signed PDF

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeRequiredDescription
idinteger (int32)YesThe unique internal ID of the merchant application

Response

200 OK

The data object is of type MerchantSignedMPAResponse.

FieldTypeDescription
dataobjectWrapper for the signed MPA response
data.filestring (byte)Base64-encoded binary content of the signed MPA PDF
statusstringHTTP status string (e.g., "OK")
errorstringError message if the request failed
warningstringNon-fatal warning message
validationResultsarrayList of validation errors, each with memberNames and errorMessage
requestIdinteger (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

CodeWhen it happens
400The id query parameter is missing or not a valid integer
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No signed MPA found for the given id — the merchant may not have completed signing yet
500Internal server error

Common Mistakes

  • Calling this endpoint before the signing process is complete — check getSignatureStatus first; if the status is not "Completed", no signed document will be available.
  • Confusing data.file (Base64-encoded binary) with data.base64Pdf from the generateMPAPDF endpoint — these are the same encoding format but represent unsigned vs. signed documents respectively.
  • Attempting to render data.file directly 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 signing
  • GET /api/v1/merchant/generateMPAPDF — generate the unsigned MPA PDF for review before signing
  • POST /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"
Query Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json