GET/api/v2/baas/pix/cash-in/{txid}

Consultar

Produto BaaS (titular). Requer Bearer JWT do login da conta e assinatura HMAC obrigatória. Scope: baas.pix-cash-in.read. Guia: documentação técnica.

Parâmetros

AcceptObrigatório
header
Tipo:string
X-SignatureObrigatório
header

Assinatura HMAC-SHA256 da requisição (hex).

Tipo:string
X-TimestampObrigatório
header

Timestamp Unix (segundos, UTC) usado na assinatura.

Tipo:string
X-NonceObrigatório
header

Nonce único por requisição (anti-replay).

Tipo:string
txidObrigatório
path

ID da cobranca retornado no POST cash-in (25 a 35 caracteres alfanumericos).

Tipo:string

Autenticação e headers

Requer Bearer token do login da conta e assinatura HMAC obrigatórios. Scope: baas.pix-cash-in.read.

HeaderObrigatórioDescrição
AuthorizationSimBearer {{access_token}}
AcceptSimapplication/json
X-SignatureSimAssinatura HMAC
X-TimestampSimTimestamp da assinatura
X-NonceSimNonce único por requisição

Path

ParâmetroObrigatórioDescrição
txidSimAlfanumérico [a-zA-Z0-9], 25 a 35 caracteres (txId do POST)

Resposta

Retorna cobrança no formato COB: status (ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP), calendario, valor, chave, pix[] (pagamentos recebidos), entre outros.

Erros comuns

CódigoCorpoCausa
422txid[]Formato inválido
404messageCobrança não encontrada
4xxerrors, detailErro upstream na consulta

Notas

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/pix/cash-in/4n6GPU2Nt3EygXTqOjQpl8eCLD' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}'
const axios = require("axios");

axios({
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v2/baas/pix/cash-in/4n6GPU2Nt3EygXTqOjQpl8eCLD",
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
  },
})
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error.response?.data || error.message));
import requests

url = "https://api-h.nuvende.com.br/api/v2/baas/pix/cash-in/4n6GPU2Nt3EygXTqOjQpl8eCLD"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
}
response = requests.get(url, headers=headers)
print(response.text)
<?php
$curl = curl_init();
$opts = [
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/baas/pix/cash-in/4n6GPU2Nt3EygXTqOjQpl8eCLD',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Accept: application/json',
    'Authorization: Bearer {{access_token}}',
    'X-Timestamp: {{timestamp}}',
    'X-Nonce: {{nonce}}',
    'X-Signature: {{signature}}',
  ],
];
curl_setopt_array($curl, $opts);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
  "txid": "4n6GPU2Nt3EygXTqOjQpl8eCLD",
  "status": "CONCLUIDA",
  "revisao": 0,
  "calendario": {
    "criacao": "2026-07-15T14:00:00.000Z",
    "expiracao": 86400,
    "dataDeVencimento": null,
    "validadeAposVencimento": null
  },
  "loc": {
    "id": 789,
    "location": "pix.exemplo.com/cob/4n6GPU2Nt3EygXTqOjQpl8eCLD",
    "tipoCob": "cob",
    "criacao": "2026-07-15T14:00:00.000Z"
  },
  "location": "pix.exemplo.com/cob/4n6GPU2Nt3EygXTqOjQpl8eCLD",
  "valor": {
    "original": "250.00",
    "modalidadeAlteracao": 0,
    "retirada": { "saque": null, "troco": null },
    "multa": { "modalidade": null, "valorPerc": null },
    "juros": { "modalidade": null, "valorPerc": null },
    "desconto": {
      "modalidade": null,
      "valorPerc": null,
      "descontoDataFixa": [
        { "data": "2026-07-20", "valorPerc": "5.00" }
      ]
    },
    "abatimento": null
  },
  "chave": "[email protected]",
  "solicitacaoPagador": "Pagamento produto exemplo",
  "qrCode": "00020126580014BR.GOV.BCB.PIX0136exemplo-payload-ficticio5204000053039865802BR5925Joao Recebedor Exemplo6009SAO PAULO62070503***6304ABCD",
  "devedor": {
    "cpf": "11144477735",
    "cnpj": null,
    "nome": "Maria Pagadora Exemplo",
    "cidade": "Sao Paulo",
    "uf": "SP",
    "cep": "01310100",
    "logradouro": "Avenida Exemplo"
  },
  "infoAdicionais": [
    { "nome": "Pedido", "valor": "ORD-2026-7890" }
  ],
  "pix": [
    {
      "id": "PIX-001",
      "endToEndId": "E3829737420260715173040123456789",
      "txid": "4n6GPU2Nt3EygXTqOjQpl8eCLD",
      "status": "CONCLUIDA",
      "valor": "250.00",
      "horario": "2026-07-15T15:30:00.000Z",
      "infoPagador": "Pagamento produto exemplo",
      "devolucoes": [
        {
          "id": "DEV-001",
          "endToEndId": "D3829737420260715173040123456789",
          "endToEndOriginal": "E3829737420260715173040123456789",
          "rtrId": "b35f3db4-7070-471f-b164-237360278686",
          "valor": "50.00",
          "horario": {
            "solicitacao": "2026-07-15T16:00:00.000Z",
            "liquidacao": "2026-07-15T16:05:00.000Z"
          },
          "status": "DEVOLVIDO"
        }
      ]
    }
  ]
}
{
  "txid": ["The txid format is invalid."]
}
{
  "message": "Not Found"
}