Acessar minha contaAbrir uma conta
PUT/api/v1/pagamentos/transactions/{id}

Atualizar

Este endpoint permite atualizar os dados de uma transação existente.

Parâmetros

Content-TypeObrigatório
header

application/json

Tipo:string
AcceptObrigatório
header

application/json

Tipo:string
AuthorizationObrigatório
header

Bearer {{ access_token }}

Tipo:string
idObrigatório
path

Identificador único da transação (UUID) a ser atualizada

Tipo:string

Parâmetros do Corpo da Requisição (Body)

Observação: Apenas os campos que você deseja alterar precisam ser enviados. Campos não incluídos na requisição permanecerão inalterados.

CampoObrigatórioTipoDescrição
statusNãoStringStatus da transação (pending, canceled, paid, processing, expired, liquided).
external_idNãoStringID externo (<= 100 caracteres).
customer_nameNãoStringNome do cliente (<= 200 caracteres).
customer_identifierNãoStringIdentificador do cliente (<= 50 caracteres).
valueNãoStringValor da transação (>= 0).
discount_valueNãoStringValor do desconto (>= 0).
net_valueNãoStringValor líquido da transação (>= 0).
urlNãoStringURL do webhook (<= 1024 caracteres).

Campos Não Modificáveis

Os seguintes campos não podem ser alterados através deste endpoint:

  • payment_method
  • type
  • installments
  • merchant_id
  • transaction_identifier
  • authorization
  • payment_date
  • created_at
  • updated_at

Códigos de Resposta

CódigoSignificadoDescrição
200OKAtualização realizada com sucesso.
401UnauthorizedToken de acesso inválido ou ausente.
403ForbiddenUsuário não possui permissão para atualizar a transação.
404Not FoundTransação com o ID especificado não foi encontrada.
422Unprocessable EntityDados da requisição inválidos.
500Internal Server ErrorErro interno no servidor.

Descrição dos Campos da Resposta

A resposta contém os dados atualizados da transação:

  • id: Identificador único da transação (UUID).
  • status: Status atual da transação.
  • payment_method: Método de pagamento utilizado.
  • type: Tipo da transação.
  • installments: Número de parcelas da transação.
  • merchant_code: Código do comerciante (pode ser null).
  • merchant_id: Identificador do comerciante (pode ser null).
  • transaction_identifier: Identificador da transação (pode ser null).
  • authorization: Código de autorização (pode ser null).
  • customer_name: Nome do cliente.
  • customer_identifier: Identificador do cliente.
  • value: Valor da transação.
  • discount_value: Valor do desconto aplicado.
  • net_value: Valor líquido da transação.
  • external_id: ID externo da transação.
  • url: URL do webhook.
  • terminal_id: ID do terminal.
  • payment_date: Data do pagamento.
  • created_at: Data de criação da transação.
  • updated_at: Data da última atualização.
curl -X PUT \
  'https://api-h.nuvende.com.br/api/v1/pagamentos/transactions/9dd1bcde-26fa-49a4-b2b1-92ffaa61abf8' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {{access_token}}' \
  -d '{
    "status": "paid",
    "customer_name": "João da Silva Atualizado",
    "customer_identifier": "123.456.789-00",
    "value": "150.75",
    "discount_value": "10.00",
    "net_value": "140.75"
  }'

const axios = require("axios");

const data = {
  status: "paid",
  customer_name: "João da Silva Atualizado",
  customer_identifier: "123.456.789-00",
  value: "150.75",
  discount_value: "10.00",
  net_value: "140.75",
};

const config = {
  method: "put",
  url: "https://api-h.nuvende.com.br/api/v1/pagamentos/transactions/9dd1bcde-26fa-49a4-b2b1-92ffaa61abf8",
  headers: {
    "Content-Type": "application/json",
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
  },
  data: data,
};

axios(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

import requests
import json

url = "https://api-h.nuvende.com.br/api/v1/pagamentos/transactions/9dd1bcde-26fa-49a4-b2b1-92ffaa61abf8"

payload = {
    "status": "paid",
    "customer_name": "João da Silva Atualizado",
    "customer_identifier": "123.456.789-00",
    "value": "150.75",
    "discount_value": "10.00",
    "net_value": "140.75"
}

headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {{access_token}}'
}

response = requests.put(url, headers=headers, data=json.dumps(payload))

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v1/pagamentos/transactions/9dd1bcde-26fa-49a4-b2b1-92ffaa61abf8',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => json_encode(array(
    'status' => 'paid',
    'customer_name' => 'João da Silva Atualizado',
    'customer_identifier' => '123.456.789-00',
    'value' => '150.75',
    'discount_value' => '10.00',
    'net_value' => '140.75'
  )),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer {{access_token}}'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>

{
  "status": "paid",
  "customer_name": "João da Silva Atualizado",
  "customer_identifier": "123.456.789-00",
  "value": "150.75",
  "discount_value": "10.00",
  "net_value": "140.75"
}

{
  "data": {
    "id": "9dd1bcde-26fa-49a4-b2b1-92ffaa61abf8",
    "status": "paid",
    "payment_method": "credit",
    "type": "payment",
    "installments": 1,
    "merchant_code": null,
    "merchant_id": null,
    "transaction_identifier": null,
    "authorization": null,
    "customer_name": "João da Silva Atualizado",
    "customer_identifier": "123.456.789-00",
    "value": "150.75",
    "discount_value": "10.00",
    "net_value": "140.75",
    "external_id": "719fb1bf-01c5-423d-b8e6-c5f49d0c3a8d",
    "url": "https://webhook-test.com/d6df4d27ec979d9bb6e78fc06c4d44b5",
    "terminal_id": "ecc1158c-89e9-4904-a8e3-656a840dfa82",
    "payment_date": "2024-12-24T14:15:22.000000Z",
    "created_at": "2024-12-26T19:30:24.000000Z",
    "updated_at": "2024-12-26T20:45:18.000000Z"
  }
}

{
  "message": "Transação não encontrada",
  "errors": {
    "id": ["A transação com o ID especificado não existe"]
  }
}

{
  "message": "Os dados fornecidos são inválidos",
  "errors": {
    "value": ["O valor deve ser um número maior ou igual a 0"],
    "status": [
      "O status deve ser um dos valores permitidos: pending, canceled, paid, processing, expired, liquided"
    ]
  }
}

{
  "message": "Token de acesso inválido",
  "error": "Unauthorized"
}

{
  "message": "Você não possui permissão para atualizar esta transação",
  "error": "Forbidden"
}

{
  "status": "paid"
}

{
  "customer_name": "Maria Santos",
  "customer_identifier": "987.654.321-00"
}

{
  "value": "200.00",
  "discount_value": "20.00",
  "net_value": "180.00"
}