get https://staging.hq.netevia.com/api/v1/merchant/generateMPAPDF
API Method: GET /api/v1/merchant/generateMPAPDF
GET /api/v1/merchant/generateMPAPDFDescription:
This API method is used to generate a Merchant Processing Agreement (MPA) in PDF format. The document includes the completed merchant's information based on the details already provided or stored in the system. The PDF serves as a legal document for the merchant, detailing the terms and conditions for the payment processing services.
URL:
GET /api/v1/merchant/generateMPAPDF
Purpose:
To generate a legally binding Merchant Processing Agreement (MPA) in PDF format with all required merchant details.
Use Cases:
- A merchant has successfully completed the onboarding process, and the payment processor needs to generate the agreement for record-keeping or distribution.
- The platform administrator or the merchant themselves can request the agreement for review, signature, or compliance purposes.
Response:
- 200 OK: A PDF document containing the completed Merchant Processing Agreement is returned.
- 404 Not Found: If the merchant’s information is incomplete or unavailable.
- 500 Internal Server Error: If there is an error generating the document.
Headers:
- Authorization: Basic token (required) - the API requires a valid token to authenticate the user requesting the document.
Request Parameters:
- merchantId (optional, query parameter): A unique identifier for the merchant. If not provided, the API will use the currently authenticated merchant.
Response Body:
- Binary content representing the PDF document.
Example Request:
GET /api/v1/merchant/generateMPAPDF?merchantId=12345
Authorization: Bearer <token>
Example Response (Success):
- Content-Type:
application/pdf - Response Body: (Binary PDF file)
Error Response Example:
- 404 Not Found
{ "error": "Merchant not found or missing required information" }
This method allows secure and convenient generation of the MPA, essential for ensuring merchant compliance with the payment processor's terms and conditions.