QivoPay

Atualizar Transação

Importante

Apenas alguns campos podem ser atualizados após a criação da transação. Transações já processadas (aprovadas/rejeitadas) têm limitações de edição.

Atualize informações específicas de uma transação existente. Este endpoint permite modificar campos como descrição, metadados e alguns dados do cliente.

Endpoint

PATCH/api/v1/transactions/{id}

Campos Editáveis

descriptionstringopcional

Descrição da transação (máximo 255 caracteres)

metadataobjectopcional

Metadados customizados (chave-valor) para armazenar informações adicionais

customer.phonestringopcional

Telefone do cliente (apenas para transações pendentes)

Restrições por Status

Transações Pendentes

Todos os campos listados podem ser editados livremente.

Transações Processadas

Apenas descrição e metadados podem ser modificados.

Transações Canceladas

Nenhum campo pode ser editado.

Exemplo de Requisição

JSON
PATCH /api/v1/transactions/txn_abc123

{
  "description": "Pagamento atualizado - Produto XYZ Premium",
  "metadata": {
    "order_id": "ORDER-123",
    "source": "website",
    "campaign": "black-friday-2023"
  },
  "customer": {
    "phone": "(11) 98765-4321"
  }
}

Resposta de Sucesso

200 OK
{
  "id": "txn_abc123",
  "status": "pending",
  "amount": 10050,
  "currency": "BRL",
  "payment_method": "credit_card",
  "description": "Pagamento atualizado - Produto XYZ Premium",
  "customer": {
    "id": "cust_xyz789",
    "name": "João Silva",
    "email": "joao@exemplo.com",
    "phone": "(11) 98765-4321"
  },
  "metadata": {
    "order_id": "ORDER-123",
    "source": "website",
    "campaign": "black-friday-2023"
  },
  "created_at": "2023-12-01T10:30:00Z",
  "updated_at": "2023-12-01T14:45:00Z"
}

Códigos de Erro

404Transação não encontrada
422Campo não editável para o status atual
400Dados inválidos