Criar anotações

Developing

POST

https://api.bestfy.io/public-api/transactions/{financialTransactionId}/notes

Cria uma anotação interna em um pedido.

Anotações são notas de uso interno da sua operação: ficam visíveis apenas para a sua empresa, no painel da Bestfy e por esta API, e nunca são exibidas ao comprador nem enviadas em e-mails ou webhooks.

O autor da anotação é o usuário dono da chave de API usada na requisição, e a anotação é registrada com source: "API" — é assim que o painel distingue o que veio da integração do que foi escrito manualmente no dashboard.

Formatação do texto

O campo content aceita um subconjunto de markdown:

Recurso	Sintaxe
Negrito	`texto`
Tachado	`~~texto~~`
Link	`[rótulo](https://exemplo.com)`
Quebra de linha	`\n`

HTML, imagens e links com protocolo diferente de http ou https são recusados com 400. O limite é de 2000 caracteres.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201Anotação criada

application/json

Bodyapplication/json

🟠400Conteudo invalido

🟠400ID da transação malformado

🟠401API Key inválida ou ausente

🟠403API Key revogada

🟠404Transação não encontrada

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://api.bestfy.io/public-api/transactions/{{$string.uuid}}/notes' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "content": "Cliente pediu troca para **tamanho M**.\nVer [ticket](https://suporte.example.com/123)"
}'

Response Example

201 - Anotação criada

{
  "id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "financialTransactionId": "019c009b-ae07-2c60-cf14-abc48d02ca1d",
  "authorUserId": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "author": {
    "id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "name": "Renato"
  },
  "source": "API",
  "content": "Cliente pediu troca para **tamanho M**.\nVer [ticket](https://suporte.example.com/123)",
  "createdAt": "2026-10-06T14:32:10.000Z",
  "updatedAt": "2026-10-06T14:32:10.000Z"
}

Modified at 2026-10-06 15:56:05

Status de Pagamento na Bestfy

Listar anotações

Criar anotações

Formatação do texto#

Request

Responses

Formatação do texto