Carteira

Anotar Transação

PATCH/v1/wallet/transactions/:transactionId

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Autenticação

bearerAuthorizationstring · header · obrigatório

Envie no header:

Authorization: Bearer {{token}}

Path Parameters

Name	Type	Required	Description
transactionId	string	Required	ID da transação a anotar

Adiciona uma anotação interna a uma transação específica para controle próprio.

Anotar transação

Grava uma observação livre na transação. Útil para controle interno (conciliação, referência de pedido, etc.).

Campo	Obrig.	Tipo	Descrição
`note`	✅	string	Texto da anotação (máx. 500 caracteres)

Erros: 400 MISSING_NOTE, 400 INVALID_NOTE, 404 TRANSACTION_NOT_FOUND.

Body

application/json

Content-Type:application/json

{
  "note": "Pagamento referente ao pedido #001"
}

Schema

Field	Type	Required	Description
note	string	-	-

Headers

Name	Type	Value	Required
Content-Type	-	application/json	Optional

← Anterior

Listar Transações

Listar Recebimentos

const url = 'https://sandbox.validapay.com.br/v1/wallet/transactions/:transactionId';

const options = {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "note": "Pagamento referente ao pedido #001"
})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200

{
  "transactionId": "txn_xxx",
  "note": "Pagamento referente ao pedido #001",
  "message": "Observação salva com sucesso"
}

404404

{
  "code": "TRANSACTION_NOT_FOUND"
}

← Anterior

Listar Transações

Listar Recebimentos