Notes for merchants

The Notes for Merchants API allows partners to retrieve and add notes related to a merchant’s profile. These notes can contain service-related information, updates about changes, or record significant events related to the merchant.

Key Features:

Retrieve Merchant Notes: Easily retrieve a log of notes for a specific merchant, providing a detailed record of service events and updates.
Add New Notes: Partners can add new notes to a merchant profile, allowing for continuous tracking of important information or events.
Message Categorization: Each note can be categorized by message type (e.g., 'CustomerService', 'Risk', 'Equipment') to ensure proper classification and tracking of merchant-related updates.
These APIs provide a clear, structured way to track merchant activities and keep a comprehensive log of service events and updates.

[GET] /api/v1/merchant/notes - The method is used to check Notes for the merchant. Notes records service information about changes in the merchant, as well as other events.
[POST] /api/v1/merchant/notes - The method is used to add Notes for the merchant.

Request [GET] /api/v1/merchant/notes:

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/notes:

{  
  "data": [  
    {  
      "text": "string",  
      "author": "string",  
      "date": "2023-12-19T07:33:22.356Z"  
    }  
  ],  
  "status": "Continue",  
  "error": "string",  
  "validationResults": \[  
    {  
      "memberNames": [  
        "string"  
      ],  
      "errorMessage": "string"  
    }  
  ],  
  "requestId": 0  
}

Request [POST] /api/v1/merchant/notes:

Parameter Name	Type	Required	Description	Validation	Example Example Values
ID MerchantProfile	TsysMerchant	TsysMerchant	Merchant profile id from submit response	Only digits	12
messageType	String	Required	Only of one value		'CustomerService', 'Risk', 'Equipment', 'POS', 'Other', 'TechSupport', 'Accounting'
note	String	Required			Note text

Response [POST] /api/v1/merchant/notes:

{  
  "data": {  
    "success": true  
  },  
  "status": "Continue",  
  "error": "string",  
  "validationResults": \[  
    {  
      "memberNames": [  
        "string"  
      ],  
      "errorMessage": "string"  
    }  
  ],  
  "requestId": 0  
}