> ## Documentation Index
> Fetch the complete documentation index at: https://developer.forebit.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update payment note

> Set or overwrite the internal note attached to a payment. Notes are visible only to your team.



## OpenAPI

````yaml https://prod-payments-api.forebit.io/openapi.json put /v1/businesses/{businessId}/payments/{paymentId}/note
openapi: 3.0.1
info:
  title: Forebit API
  description: >-
    Accept crypto payments across Bitcoin, Ethereum, Tron, and other networks.
    Create payments, manage businesses, and track transactions through a single
    unified interface.
  termsOfService: https://forebit.io/terms
  contact:
    name: Forebit Team
    email: support@forebit.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: v1.0.0
servers:
  - url: https://prod-payments-api.forebit.io/
security:
  - Bearer: []
tags:
  - name: Payments
    description: Create, list, and inspect crypto payments for a business.
  - name: Payments
    description: Payments
paths:
  /v1/businesses/{businessId}/payments/{paymentId}/note:
    put:
      tags:
        - Payments
      summary: Update payment note
      description: >-
        Set or overwrite the internal note attached to a payment. Notes are
        visible only to your team.
      operationId: EditNotePayment
      parameters:
        - name: businessId
          in: path
          description: The target business ID.
          required: true
          schema:
            type: integer
            format: int64
        - name: paymentId
          in: path
          description: The payment to annotate.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: The new note content.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditPaymentNoteRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/EditPaymentNoteRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/EditPaymentNoteRequest'
      responses:
        '200':
          description: Note saved.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '401':
          description: Missing or invalid authentication token.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: No payment matches this ID.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    EditPaymentNoteRequest:
      type: object
      properties:
        note:
          maxLength: 256
          type: string
          nullable: true
      additionalProperties: false
    BaseResponse:
      type: object
      properties:
        message:
          type: string
          nullable: true
        errors:
          type: array
          items:
            type: string
          nullable: true
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
  securitySchemes:
    Bearer:
      type: http
      description: Pass your JWT token in the Authorization header as a Bearer token.
      scheme: bearer
      bearerFormat: JWT

````