GET/api/v2/cobranca/cobv/{txid}

Consultar

Consulta Cobv pelo txid. Scope: cobv.read.

Parâmetros

AcceptObrigató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.read.

Path

txid — identificador da cobrança com vencimento (definido pelo recebedor na criação).

Retorno 200

Recurso Cobv completo (txid, status, calendario, valor, devedor, chave, loc, pix quando pago).

Notas

curl --location 'https://api-h.nuvende.com.br/api/v2/cobranca/cobv/G8kSgU5AVIX1y4CZJaHdjb3lo' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'
{
  "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": []
}
{
  "txid": "G8kSgU5AVIX1y4CZJaHdjb3lo",
  "revisao": 1,
  "status": "CONCLUIDA",
  "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": [
    {
      "id": "001f7eb9-d3d0-41f5-922f-baf963c544f8",
      "endToEndId": "E3829737420250910193643362909064",
      "txid": "G8kSgU5AVIX1y4CZJaHdjb3lo",
      "status": "CONFIRMADO",
      "valor": 150.0,
      "horario": "2024-10-04T23:12:25.000000Z",
      "infoPagador": null,
      "bancoPagador": {
        "ispb": "12345678",
        "nome": "Banco Pagador Exemplo"
      },
      "bancoRecebedor": {
        "ispb": "87654321",
        "nome": "Banco Recebedor Exemplo"
      },
      "devolucoes": []
    }
  ]
}