curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/QRCode/ConsultarByCodigoBoleto/{codigoBoleto} \
  --header 'Authorization: <api-key>'
{
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "origemRegistro": 0,
  "dtInclusao": "2023-11-07T05:31:56Z",
  "txId": "<string>",
  "dtVencimento": "2023-11-07T05:31:56Z",
  "validadeAposVencimento": 123,
  "expiracao": 123,
  "chave": "<string>",
  "valor": 123,
  "solicitacaoPagador": "<string>",
  "cpfRecebedor": "<string>",
  "cnpjRecebedor": "<string>",
  "nomeRecebedor": "<string>",
  "nomeFantasiaRecebedor": "<string>",
  "logradouroRecebedor": "<string>",
  "cidadeRecebedor": "<string>",
  "ufRecebedor": "<string>",
  "cepRecebedor": "<string>",
  "cpfDevedor": "<string>",
  "cnpjDevedor": "<string>",
  "nomeDevedor": "<string>",
  "emailDevedor": "<string>",
  "logradouroDevedor": "<string>",
  "cidadeDevedor": "<string>",
  "ufDevedor": "<string>",
  "cepDevedor": "<string>",
  "nomeComerciante": "<string>",
  "cidadeComerciante": "<string>",
  "emv": "<string>",
  "url": "<string>",
  "imagem": "<string>",
  "situacao": 1
}

Through this endpoint, partners can consult a QR code that has already been provided on a specific boleto. In this case, it refers to a boleto that allows hybrid payment, meaning it can be paid using either a barcode or a QR code.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Path Parameters

​
codigoBoleto
string
required

Identificador UUID do Boleto Bancário em que o QR Code deve ser consultado.

Response

200 - application/json
Success
​
codigo
string

Código UUID identificador do QR Code.

​
origemRegistro
enum<integer>

Identificador da API que foi utilizada para gerar o QR Code.

Available options:
0,
1,
2,
3,
4,
5,
99
​
dtInclusao
string

Data de inclusão do registro.

​
txId
string | null

Código identificador da transação.

​
dtVencimento
string

Data de vencimento.

​
validadeAposVencimento
integer

Validade contada a partir da data de vencimento em dias. Utilizado em QR Codes do tipo Cobrança.

​
expiracao
integer

Validade contada a partir da geração do QR Code em segundos. Utilizado em QR Codes do tipo Imediato.

​
chave
string | null

Chave PIX vinculada ao QR Code.

​
valor
number

Valor da transação.

​
solicitacaoPagador
string | null

Texto apresentado ao pagador para que este possa digitar uma informação correlata a ser enviada ao recebedor.

​
cpfRecebedor
string | null

CPF do recebedor.

​
cnpjRecebedor
string | null

CNPJ do recebedor.

​
nomeRecebedor
string | null

Nome do recebedor.

​
nomeFantasiaRecebedor
string | null

Nome Fantasia do recebedor.

​
logradouroRecebedor
string | null

Logradouro do recebedor.

​
cidadeRecebedor
string | null

Cidade do recebedor.

​
ufRecebedor
string | null

UF do recebedor.

​
cepRecebedor
string | null

CEP do recebedor.

​
cpfDevedor
string | null

CPF do recebedor.

​
cnpjDevedor
string | null

CNPJ do recebedor.

​
nomeDevedor
string | null

Nome do devedor.

​
emailDevedor
string | null

E-mail do devedor.

​
logradouroDevedor
string | null

Logradouro do devedor.

​
cidadeDevedor
string | null

Cidade do devedor.

​
ufDevedor
string | null

UF do devedor.

​
cepDevedor
string | null

CEP do devedor.

​
nomeComerciante
string | null

Nome do devedor.

​
cidadeComerciante
string | null

Cidade do devedor.

​
emv
string | null

Conteúdo do QR Code.

​
url
string | null

URL do payload dinâmico gerado.

​
imagem
string | null

Imagem do QR Code codificada em Base64.

​
situacao
enum<integer>

1 = Registrado; 2 = Cancelado; 3 = Pago

Available options:
1,
2,
3

Was this page helpful?