curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/QRCode/Ler \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "tipoQRCode": "<string>",
  "codigoLeituraQRCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tpQRCode": 1,
  "chave": "<string>",
  "reutilizavel": true,
  "reutilizavelEspecificado": true,
  "valor": 123,
  "valorEspecificado": true,
  "documentoFederal": "<string>",
  "informacoesAdicionais": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "nome": "<string>",
  "cidade": "<string>",
  "url": "<string>"
}

Through this endpoint, partners can perform a payment QR code scan using a mobile device.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
ContaDto.Agencia
string

Número da Agência Bancária.

​
ContaDto.AgenciaDigito
string

Dígito verificador da Agência Bancária.

​
ContaDto.Conta
string

Número da Conta Bancária.

​
ContaDto.ContaDigito
string

Dígito verificador do número da Conta Bancária.

​
ContaDto.ContaPgto
string

Número da Conta Bancária seguido do dígito verificador.

​
ContaDto.TipoConta
enum<integer>

1 = Corrente<br>2 = Poupanca<br>3 = Pagamento<br>4 = Salario

Available options:
1,
2,
3,
4
​
ContaDto.ModeloConta
enum<integer>

1 = Movimento<br>2 = Escrow<br>3 = Vinculada

Available options:
1,
2,
3
​
EMV
string

Código EMV do QR Code, conforme o padrão EMVCo.

Response

200 - application/json
Success
​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
tipoQRCode
string | null

Tipo do QR Code, pode ser "ESTATICO" ou "DINAMICO".

​
codigoLeituraQRCode
string

Código UUID Identificador da consulta realizada.

​
tpQRCode
enum<integer>

1 = Estatico; 2 = Dinamico

Available options:
1,
2
​
chave
string | null

Chave PIX vinculada ao QR Code.

​
reutilizavel
boolean | null

Indica se o QR Code é reutilizável.

​
reutilizavelEspecificado
boolean | null

Indica se o campo "Reutilizavel" foi especificado.

​
valor
number | null

Valor cobrado no QR Code.

​
valorEspecificado
boolean | null

Indica se o campo "Valor" foi especificado.

​
documentoFederal
string | null

Documento Federal do recebedor.

​
informacoesAdicionais
string | null

Informações adicionais exibidas ao pagador no momento da leitura do QR Code.

​
idConciliacaoRecebedor
string | null

Identificador único para conciliação do recebedor.

​
nome
string | null

Nome do recebedor.

​
cidade
string | null

Cidade do recebedor.

​
url
string | null

URL do payload dinâmico gerado, caso o QR Code seja dinâmico.

Was this page helpful?