MPA merchant sign
The MPA Merchant Sign API allows partners to generate a Merchant Processing Agreement (MPA) PDF, initiate the signing process, and track the status of the application signature. This suite of APIs streamlines the signature process, ensuring merchants can digitally sign their agreements efficiently.
Key Features:
- Generate MPA PDF: Easily generate a base64-encoded Merchant Processing Agreement PDF for merchants to review and sign.
- Initiate the Signing Process: Direct merchants to a signature platform (e.g., DocuSign) with a provided URL, ensuring a seamless digital signature experience.
- Track Signature Status: Retrieve the current signing status to monitor whether the merchant has completed the signing process or if it's still pending.
- These APIs simplify the merchant agreement signing process, providing a seamless and integrated solution for managing MPA documentation and signatures.
- [GET] /api/v1/merchant/generateMPAPDF - The method is used to generate MPA PDF that needs to be signed.
- [POST] /api/v1/merchant/requestSignature - The method is used to start the application signing process
- [GET] /api/v1/merchant/getSignatureStatus - The method is used to request the application signing status
Request [GET] /api/v1/merchant/generateMPAPDF:
| Parameter Name | Type | Required | Description | Validation | Example Example Values |
|---|---|---|---|---|---|
| ID MerchantProfile | TsysMerchant | TsysMerchant | Merchant profile id from submit response | Only digits | 12 |
Response [GET] /api/v1/merchant/generateMPAPDF:
{
"data": {
"base64Pdf": "YOUR PDF ENCODED IN BASE64"
},
"status": 200,
"requestId": 0
}
Request [POST] /api/v1/merchant/requestSignature:
| Parameter Name | Type | Required | Description | Validation | Example Example Values |
|---|---|---|---|---|---|
| ID MerchantProfile | TsysMerchant | TsysMerchant | Merchant profile id from submit response | Only digits | 12 |
| returnUrl | String | Required | URL to which the user will be redirected after signing | Like URL | https://hq.netevia.com |
| cmsform | |||||
| addForm | boolean | optional | True | ||
| oneTimeSetupFee | number | optional | Number | 11 | |
| cmsMonthlyFee | number | optional | Number | 22 | |
| RollingReserveForm | RollingReserve Parameters | ||||
| addForm | boolean | optional | True | ||
| withholding | number | optional | Number | 33 |
Response [POST] /api/v1/merchant/requestSignature:
{
"data": {
"url": "URL TO DOCUSIGN"
},
"status": 200,
"requestId": 0
}
Request [GET] /api/v1/merchant/getSignatureStatus:
| Parameter Name | Type | Required | Description | Validation | Example Example Values |
|---|---|---|---|---|---|
| ID MerchantProfile | TsysMerchant | TsysMerchant | Merchant profile id from submit response | Only digits | 12 |
Response [GET] /api/v1/merchant/getSignatureStatus:
{
"data": {
"signingStatus": "string"
},
"status": "Continue",
"error": "string",
"warning": "string",
"validationResults": \[
{
"memberNames": [
"string"
],
"errorMessage": "string"
}
],
"requestId": 0
}
Updated about 1 month ago