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/getSignedMPA
Description:
This API endpoint is used to retrieve a signed copy of the Merchant Processing Agreement (MPA) in PDF format. The MPA is a legal document that outlines the terms and conditions of the payment processing service between the merchant and the payment service provider. Once signed, the agreement is stored securely, and this endpoint allows for the retrieval of the signed document.
Request:
- HTTP Method: GET
- Endpoint:
/api/v1/merchant/getSignedMPA
Parameters:
- merchantId (query parameter, required):
A unique identifier for the merchant whose signed MPA is being requested.- Type: String
- Example:
merchantId=12345ABC
Response:
-
Status Code:
200 OK: If the signed MPA is successfully retrieved.400 Bad Request: If the required parameters are missing or invalid.404 Not Found: If the merchant or signed MPA does not exist.500 Internal Server Error: If there is an issue processing the request.
-
Response Body:
The response will contain the signed MPA as a binary file in the specified format (PDF). The file can then be downloaded or viewed.
Example Request:
GET /api/v1/merchant/getSignedMPA?merchantId=12345ABC
- Body:
The body contains the binary content of the signed MPA in the PDF format.
Use Case:
Merchants or administrative staff can use this endpoint to retrieve and review the signed MPA for a merchant, ensuring that they have access to the legal agreement and can store it for future reference.