Acessar minha contaAbrir uma conta
PUT/api/v2/cobranca/cobv/{txid}

Criar

Cria Cobv para o txid informado (idempotente). Scope: cobv.write.

Parâmetros

AcceptObrigatório
header
Tipo:string
Content-TypeObrigatório
header
Tipo:string
txidObrigatório
path
Tipo:string

Autenticação e scopes

Limitação (Cobv): scopes cobv.read e cobv.write exigidos. Token sem cobv.* retorna 403.

Requer Bearer token com scope cobv.write.

Body (principais campos)

CampoObrigatórioDescrição
chaveSimChave Pix do recebedor
nomeRecebedorSimNome do recebedor
calendario.dataDeVencimentoSimData de vencimento (YYYY-MM-DD)
calendario.validadeAposVencimentoNãoDias úteis após vencimento
valor.originalSimValor da cobrança
valor.multa / juros / descontoNãoComponentes de valor (padrão BCB)
devedorSimNome + CPF ou CNPJ
solicitacaoPagadorNãoTexto exibido ao pagador

O txid é obrigatório na URL (definido pelo recebedor antes da criação).

Retorno 200 / 201

Recurso Cobv (txid, revisao, status, calendario, valor, devedor, qrCode, chave, solicitacaoPagador, loc, pix).

Notas

curl --location --request PUT 'https://api-h.nuvende.com.br/api/v2/cobranca/cobv/G8kSgU5AVIX1y4CZJaHdjb3lo' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
--data '{
  "chave": "e3fe4462-4c8e-42c1-8360-b41b404ae557",
  "nomeRecebedor": "Loja Exemplo LTDA",
  "calendario": {
    "dataDeVencimento": "2026-08-15",
    "validadeAposVencimento": 30
  },
  "valor": { "original": "150.00" },
  "devedor": { "nome": "Maria Pagadora Exemplo", "cpf": "11144477735" },
  "solicitacaoPagador": "Fatura 123"
}'

{
  "txid": "G8kSgU5AVIX1y4CZJaHdjb3lo",
  "revisao": 0,
  "status": "ATIVA",
  "calendario": {
    "criacao": "2024-10-04T21:42:56.000000Z",
    "dataDeVencimento": "2026-08-15",
    "validadeAposVencimento": 30
  },
  "devedor": {
    "nome": "Maria Pagadora Exemplo",
    "cpf": "11144477735"
  },
  "valor": { "original": "150.00" },
  "qrCode": "00020101021226730014br.gov.bcb.pix...",
  "chave": "e3fe4462-4c8e-42c1-8360-b41b404ae557",
  "solicitacaoPagador": "Fatura 123",
  "loc": {
    "id": 1,
    "location": "https://pix.example.com/cobv/abc",
    "tipoCob": "cobv"
  },
  "pix": []
}