Skip to content

✏️ Atualizar Transação

Permite a edição manual de campos administrativos e financeiros de uma transação para fins de conciliação administrativa e correções de ledger no Backoffice.

Endpoint: PUT/PATCH /backoffice/transactions/\{id\}


📥 Parâmetros de Entrada (Body JSON)

CampoTipoDescriçãoObrigatório/Opcional
valuenumericNovo valor monetário da transação.Opcional
statusintegerCódigo de status da transação (0 = Pendente, 1 = Confirmada, 2 = Cancelada, -1 = Erro, 4 = Concluída).Opcional
namestringNome do pagador (alias para payer_name).Opcional
documentstringCPF ou CNPJ do pagador (alias para payer_document).Opcional
payer_namestringNome do pagador.Opcional
payer_documentstringCPF ou CNPJ do pagador (validado por CPF/CNPJ).Opcional
receiver_namestringNome do recebedor.Opcional
receiver_documentstringCPF ou CNPJ do recebedor.Opcional
accountIdintegerID da conta vinculada (alias para account_id).Opcional
account_idintegerID da conta vinculada (deve existir na base).Opcional
typeintegerID da categoria/tipo de transação (alias para type_id).Opcional
type_idintegerID da categoria/tipo de transação.Opcional
descriptionstringDescrição textual da transação.Opcional
currencystringCódigo da moeda (ex: BRL).Opcional
originstringOrigem da transação (ex: PIX).Opcional
payer_bank_namestringNome do banco pagador.Opcional
payer_agencystringAgência bancária do pagador.Opcional
payer_accountstringConta bancária do pagador.Opcional
receiver_bank_namestringNome do banco recebedor.Opcional
receiver_agencystringAgência bancária do recebedor.Opcional
receiver_accountstringConta bancária do recebedor.Opcional
metadataobjectMetadados adicionais da transação em JSON.Opcional
detailsobjectDetalhes complementares da operação.Opcional

Payload de Exemplo (JSON)

json
{
  "value": 1750.50,
  "status": 1,
  "name": "Cliente VIP Ltda",
  "document": "83884813000109",
  "accountId": 2,
  "type": 1,
  "description": "Ajuste manual de transação pix",
  "metadata": {
    "adjusted_by": "admin",
    "reason": "Erro de conciliação automática"
  }
}

📤 Retorno de Sucesso (200 OK)

json
{
    "code": 200,
    "success": true,
    "transaction": {
        "id": 1,
        "txid": "E123456789...",
        "endtoendid": "E123456789...",
        "value": 1750.50,
        "status": 1,
        "description": "Ajuste manual de transação pix",
        "datetime": "2024-04-20 12:00:00",
        "balance": 5000.00,
        "bank_details": {
            "bank": "001",
            "agency": "1234",
            "account": "567890"
        },
        "account": { "id": 2, "name": "Conta Exemplo" },
        "type": { "id": 1, "name": "PIX_IN", "description": "Entrada de Pix" },
        "payer": {
            "name": "Cliente VIP Ltda",
            "document": "83884813000109",
            "bank": "Banco Teste",
            "agency": "0001",
            "account": "112233"
        },
        "receiver": {
            "name": "Usuario B",
            "document": "11111111111",
            "bank": "FastGiveMoney",
            "agency": "0001",
            "account": "445566"
        },
        "created_by": { "id": 5, "name": "Admin" },
        "created_at": "2024-04-20 12:00:00",
        "updated_at": "2026-05-21 09:10:00",
        "currency": "BRL",
        "metadata": {
            "adjusted_by": "admin",
            "reason": "Erro de conciliação automática"
        }
    },
    "message": "Transaction updated successfully"
}

❌ Erros Comuns

CódigoDescrição
401Não Autorizado: Token ausente ou inválido.
422Erro de Validação: Dados enviados estão fora do formato esperado (ex: type_id inexistente).
404Não Encontrado: Transação inexistente.

FastGivr API Documentation