Skip to main content
PUT
/
v1
/
businesses
/
{businessId}
/
payments
/
{paymentId}
/
note
Update payment note
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({note: '<string>'})
};

fetch('https://prod-payments-api.forebit.io/v1/businesses/{businessId}/payments/{paymentId}/note', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "message": "<string>",
  "errors": [
    "<string>"
  ]
}

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.

Authorizations

​
Authorization
string
header
required

Pass your JWT token in the Authorization header as a Bearer token.

Path Parameters

​
businessId
integer<int64>
required

The target business ID.

​
paymentId
string<uuid>
required

The payment to annotate.

Body

The new note content.

​
note
string | null
Maximum string length: 256

Response

Note saved.

​
message
string | null
​
errors
string[] | null