Add Note

Adds a categorized note to a merchant's profile or application record. Notes can represent comments, observations, or important details recorded during the merchant management and onboarding process. Each note must be assigned a message type that routes it to the appropriate team.

Endpoint

POST /api/v1/merchant/note

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 to document important events, observations, or follow-up items on a merchant's record during the boarding or ongoing management process. Notes are scoped by messageType so the right team (Risk, Customer Service, Tech Support, etc.) can filter and act on them. This is particularly useful for underwriting review workflows where an audit trail of communications is required.

Request Body

{
  "id": 48291,
  "messageType": "Risk",
  "note": "Merchant requested increase in monthly volume cap. Reviewing processing history for the past 6 months before approval."
}

Response

200 OK

{
  "data": {
    "success": true
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 90341
}

Error Codes

Common Mistakes

• Omitting messageType — all three fields (id, messageType, note) are required.
• Using an invalid enum value for messageType — must be exactly one of the seven listed values (case-sensitive).
• Passing a non-existent id — verify the merchant profile ID using the merchant status or search endpoints before posting a note.
• Sending an empty string for note — the note content must be non-empty.

Related Endpoints

• GET /api/v1/merchant/notes — retrieve all notes for a merchant
• POST /api/v1/merchant/attachment — upload a file attachment to a merchant record
• POST /api/v1/merchant/approve — submit a merchant for underwriting approval

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/merchant/note \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 48291,
    "messageType": "Risk",
    "note": "Merchant requested increase in monthly volume cap. Reviewing processing history for the past 6 months before approval."
  }'