Pular para o conteúdo principal
POST
/
v1
/
qrcodes
/
decode
Decodificar QR code
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qrCode": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000",
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d"
}
'
{
  "qrCodeType": "STATIC",
  "endToEndId": "E1234567820230615123456789012345",
  "amount": 100.5,
  "key": "+5511987654321",
  "description": "Payment for services",
  "txId": "tx_abc123",
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  }
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Corpo

application/json
​
qrCode
string
obrigatório

String do QR code PIX a ser decodificada.

Exemplo:

"00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000"

​
accountId
string<uuid>
obrigatório

Identificador da conta solicitando a decodificacao.

Exemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

Resposta

QR code decodificado com sucesso

​
qrCodeType
enum<string>
obrigatório

Tipo de QR code PIX. Valores string indicando o comportamento e reutilizacao do QR code.

Valores validos:

  • STATIC = QR code reutilizavel com valor fixo (pode ser escaneado varias vezes)
  • DYNAMIC = QR code de uso unico (com tempo de expiracao e validacao avancada)
Opções disponíveis:
STATIC,
DYNAMIC
Exemplo:

"STATIC"

​
endToEndId
string
obrigatório

Identificador de transacao ponta a ponta.

Exemplo:

"E1234567820230615123456789012345"

​
amount
number<double>
obrigatório

Valor do pagamento.

Exemplo:

100.5

​
key
string
obrigatório

Chave PIX do destinatario.

Exemplo:

"+5511987654321"

​
description
string
obrigatório

Descricao do pagamento.

Exemplo:

"Payment for services"

​
txId
string
obrigatório

Identificador unico da transacao.

Exemplo:

"tx_abc123"

​
payee
object
obrigatório

Informacoes da conta bancaria.