Acessar minha contaAbrir uma conta
GET/api/v2/cobranca/cob/{txid}

Consultar

Consulta Cob imediata pelo txid. Scope: cob.read. Retorna status, QR Code (qrCode) e pagamentos Pix em pix[] quando liquidada.

Parâmetros

AcceptObrigatório
header

Tipo de conteúdo aceito na resposta

Tipo:string
AuthorizationObrigatório
header

Token de autenticação Bearer

Tipo:string
txidObrigatório
path

Txid retornado na criacao (POST ou PUT).

Tipo:string

Descrição dos Campos da Resposta

NomeTipoDescrição
txidStringIdentificador único da transação Pix
revisaoInteiroNúmero da revisão da cobrança
statusStringStatus atual da cobrança (ATIVA, CONCLUIDA, etc.)
calendario.criacaoStringData e hora de criação da cobrança (formato ISO 8601)
calendario.expiracaoInteiroTempo (em segundos) para expiração da cobrança
devedorObjetoDados do devedor (nome, cpf ou cnpj)
valor.originalStringValor original da cobrança
valor.modalidadeAlteracaoInteiroModalidade de alteração do valor (1 = permitido, 0 = não permitido)
qrCodeStringCódigo QR para pagamento Pix
chaveStringChave Pix associada à cobrança
solicitacaoPagadorStringMensagem enviada ao pagador
pixArrayDetalhes dos pagamentos Pix vinculados à cobrança (vazio se não houver)

Status da Cobrança (Pix)

NomeDescrição
ATIVACobrança ativa e disponível para pagamento
EFETIVADOCobrança paga e concluída com sucesso
CANCELADOCobrança cancelada pelo usuário recebedor

Observações sobre Status

  • O status ATIVA indica que a cobrança está disponível para ser paga
  • Após o pagamento, o status muda para CONCLUIDA
  • Os status REMOVIDA_PELO_USUARIO_RECEBEDOR e REMOVIDA_PELO_PSP indicam que a cobrança foi cancelada
  • Uma vez removida ou concluída, a cobrança não pode ser reativada

Códigos de Resposta

CódigoSignificadoDescrição
200OKCobrança consultada com sucesso
400Bad RequestParâmetros inválidos ou faltando na requisição
401UnauthorizedToken de autenticação inválido ou expirado
404Not FoundCobrança não encontrada
500Internal Server ErrorErro interno no servidor. Contate o suporte se o problema persistir

Notas Importantes

  • O txid deve ser fornecido como parte da URL para localizar a cobrança específica
  • Certifique-se de substituir os placeholders ({{ txid }}, {{ access_token }}) pelos valores corretos
  • O campo qrCode pode ser utilizado diretamente pelo pagador para realizar o pagamento via Pix
curl --location 'https://api-h.nuvende.com.br/api/v2/cobranca/cob/JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'

const axios = require("axios");

axios({
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v2/cobranca/cob/JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd",
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
  },
})
  .then((response) => console.log(JSON.stringify(response.data, null, 2)))
  .catch((error) => console.log(error.response?.data || error.message));

import requests

url = "https://api-h.nuvende.com.br/api/v2/cobranca/cob/JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
}
response = requests.get(url, headers=headers)
print(response.text)

<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-h.nuvende.com.br/api/v2/cobranca/cob/JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Authorization: Bearer {{access_token}}",
  ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>

{
  "txid": "JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd",
  "revisao": 0,
  "status": "ATIVA",
  "calendario": {
    "criacao": "2024-10-04T21:42:56.000000Z",
    "expiracao": 3600
  },
  "devedor": {
    "nome": "Maria Pagadora Exemplo",
    "cpf": "11144477735"
  },
  "valor": {
    "original": "10.01",
    "modalidadeAlteracao": 0
  },
  "qrCode": "00020126580014BR.GOV.BCB.PIX0136exemplo-payload-ficticio5204000053039865802BR5925Joao Recebedor Exemplo6009SAO PAULO62070503***6304ABCD",
  "chave": "[email protected]",
  "solicitacaoPagador": "Pedido 123",
  "pix": []
}

{
  "txid": "JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd",
  "revisao": 1,
  "status": "EFETIVADO",
  "calendario": {
    "criacao": "2024-10-04T21:42:56.000000Z",
    "expiracao": 3600
  },
  "devedor": {
    "nome": "Maria Pagadora Exemplo",
    "cpf": "11144477735"
  },
  "valor": {
    "original": "10.01",
    "modalidadeAlteracao": 0
  },
  "qrCode": "00020126580014BR.GOV.BCB.PIX0136exemplo-payload-ficticio5204000053039865802BR5925Joao Recebedor Exemplo6009SAO PAULO62070503***6304ABCD",
  "chave": "[email protected]",
  "solicitacaoPagador": "Pedido 123",
  "pix": [
    {
      "id": "001f7eb9-d3d0-41f5-922f-baf963c544f8",
      "endToEndId": "E0435879820200123221500000000001",
      "txid": "JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd",
      "status": "CONFIRMADO",
      "valor": "10.01",
      "horario": "2024-10-04T23:12:25.000000Z",
      "infoPagador": null,
      "bancoPagador": {
        "ispb": "12345678",
        "nome": "Banco Pagador Exemplo"
      },
      "bancoRecebedor": {
        "ispb": "87654321",
        "nome": "Banco Recebedor Exemplo"
      },
      "devolucoes": []
    }
  ]
}

{
  "message": "Cobranca nao encontrada com o txid informado",
  "error": ["not_found"]
}

{
  "message": "Invalid token",
  "error": ["invalid_token"]
}