Skip to main content
Permite atualizar campos customizáveis de uma venda, como os metadados definidos pelo usuário (user_metadata). Útil para associar informações adicionais de negócio a uma transação sem alterar seu comportamento financeiro.

​
Autenticação

Requer Organization Access Token via header Authorization: Bearer. Escopos aceitos: web:write ou sales:write.

​
Parâmetros de Path

​
id
string
required
Identificador único da venda a ser atualizada.

​
Corpo da Requisição

​
user_metadata
object
Objeto de metadados customizados definidos pelo usuário. Aceita qualquer par chave-valor.

​
Resposta

Retorna o objeto de venda atualizado com todos os campos.
​
id
string
Identificador único da venda.
​
status
string
Status atual da venda.
​
amount
integer
Valor total da venda em centavos.
​
payment_type
string
Tipo de pagamento utilizado: credit, boleto ou pix.
​
user_metadata
object
Metadados customizados atualizados.
​
created_at
string
Data e hora de criação da venda no formato ISO 8601.

​
Exemplo

curl -X PATCH "https://api.chargefy.io/api/v1/sales/sale_01j9abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "user_metadata": {
      "pedido_interno": "PED-9876",
      "canal": "whatsapp"
    }
  }'

​
Resposta de Exemplo

{
  "id": "sale_01j9abc123",
  "status": "succeeded",
  "amount": 9900,
  "payment_type": "credit",
  "user_metadata": {
    "pedido_interno": "PED-9876",
    "canal": "whatsapp"
  },
  "created_at": "2024-11-01T12:00:00Z"
}