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

Atualizar

Esta API permite atualizar os dados de um comerciante existente.

Parâmetros

Content-TypeObrigatório
header

application/json

Tipo:string
AcceptObrigatório
header

application/json

Tipo:string
AuthorizationObrigatório
header

Bearer {{TOKEN}}

Tipo:string
idObrigatório
path

ID do comerciante a ser atualizado

Tipo:string

Descrição dos Campos da Requisição

  • pix_integration: Novo tipo de integração Pix
  • code: Novo código único do comerciante
  • name: Novo nome do comerciante
  • document: Novo documento do comerciante (CNPJ/CPF)
  • external_id: Novo identificador externo do comerciante
  • account_id: Novo ID da conta associada
  • pix_key: Nova chave Pix do comerciante
  • channel_id: Novo ID do canal

Descrição dos Campos da Resposta

  • success: Booleano indicando o sucesso ou falha da operação
  • message: Mensagem informativa sobre o resultado da operação
  • data: Objeto contendo os dados do comerciante atualizado
    • id: ID único do comerciante (UUID)
    • pix_integration: Tipo de integração Pix
    • code: Código do comerciante
    • name: Nome do comerciante
    • document: Documento do comerciante (ex: CNPJ, CPF)
    • account_id: ID da conta
    • pix_key: Chave Pix
    • account_token: Token da conta (pode ser null)
    • external_id: ID externo do comerciante
    • channel_id: ID do canal
    • created_at: Data e hora de criação (formato ISO 8601)
    • updated_at: Data e hora da última atualização (formato ISO 8601)
curl --location --request PUT 'https://api-h.nuvende.com.br/api/v1/pagamentos/merchants/{{ merchant_id }}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ access_token }}' \
--data '{
  "pix_integration": "external",
  "code": "{{$randomUUID}}",
  "name": "{{$randomCompanyName}}",
  "document": "{{cnpj}}",
  "external_id": "{{$randomUUID}}",
  "account_id": "{{$randomUUID}}",
  "pix_key": "{{$randomUUID}}",
  "channel_id": "{{channelId}}"
}'

const axios = require("axios");

const data = {
  pix_integration: "external",
  code: "{{$randomUUID}}",
  name: "{{$randomCompanyName}}",
  document: "{{cnpj}}",
  external_id: "{{$randomUUID}}",
  account_id: "{{$randomUUID}}",
  pix_key: "{{$randomUUID}}",
  channel_id: "{{channelId}}",
};

const config = {
  method: "put",
  url: "https://api-h.nuvende.com.br/api/v1/pagamentos/merchants/{{ merchant_id }}",
  headers: {
    "Content-Type": "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/merchants/{{ merchant_id }}"

payload = {
    "pix_integration": "external",
    "code": "{{$randomUUID}}",
    "name": "{{$randomCompanyName}}",
    "document": "{{cnpj}}",
    "external_id": "{{$randomUUID}}",
    "account_id": "{{$randomUUID}}",
    "pix_key": "{{$randomUUID}}",
    "channel_id": "{{channelId}}"
}

headers = {
    'Content-Type': '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/merchants/{{ merchant_id }}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => json_encode(array(
    'pix_integration' => 'external',
    'code' => '{{$randomUUID}}',
    'name' => '{{$randomCompanyName}}',
    'document' => '{{cnpj}}',
    'external_id' => '{{$randomUUID}}',
    'account_id' => '{{$randomUUID}}',
    'pix_key' => '{{$randomUUID}}',
    'channel_id' => '{{channelId}}'
  )),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {{ access_token }}'
  ),
));

$response = curl_exec($curl);

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

{
  "pix_integration": "external",
  "code": "{{$randomUUID}}",
  "name": "{{$randomCompanyName}}",
  "document": "{{cnpj}}",
  "external_id": "{{$randomUUID}}",
  "account_id": "{{$randomUUID}}",
  "pix_key": "{{$randomUUID}}",
  "channel_id": "{{channelId}}"
}

{
  "success": true,
  "message": "Merchant updated successfully",
  "data": {
    "id": "9dd1b1eb-7583-45e6-9d6f-812cfc8b1ba1",
    "pix_integration": "external",
    "code": "91b4a824-f83c-488d-85df-501ef0657ba2",
    "name": "Wilderman, Williamson and Jenkins",
    "document": "11222333000181",
    "account_id": "49b3f79a-c84a-4190-a5e7-a284f549944a",
    "pix_key": "fa24f2f4-a75c-4b3c-958a-33be337fd5dd",
    "account_token": null,
    "external_id": "50561627-15f8-4615-8621-f1b99f965909",
    "channel_id": "0591d83c-03a3-4fc6-8812-9baabb170843",
    "created_at": "2024-12-26T18:59:47+00:00",
    "updated_at": "2024-12-26T19:00:11+00:00"
  }
}