Skip to main content
POST
Decodificar QR code Pix pela URL de payload

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
accountId
string
obrigatório

O id da conta no CRM do pagador que escaneia (fonte do documento PI-PayerID).

payloadUrl
string
obrigatório

A URL de payload JWS publicada pelo recebedor a decodificar (urlPayloadJson; sem esquema).

municipalityCode
string

Código do município do pagador (codMun; cálculo de feriado da cobv).

paymentDate
string

Data pretendida de pagamento (dPP; aaaa-mm-dd; cálculo de valorFinal da cobv).

Resposta

OK

amount
number<double>
obrigatório

O valor decodificado em reais.

payee
object
obrigatório
qrCodeType
string
obrigatório

O tipo de QR decodificado (STATIC ou DYNAMIC; cobv se dobra em DYNAMIC).

amountTroco
number<double>

O valor do Pix Troco em reais (somente troco).

bankIdPss
integer<int64>

O ISPB do participante PSS de saque/troco.

description
string

Dados adicionais (dadosAdicionais).

dueDate
string

Data de vencimento (cobv/estático opcional).

endToEndId
string

O id ponta a ponta do SPI.

isPixSaque
boolean

Se o QR carrega uma perna de Pix Saque.

isPixTroco
boolean

Se o QR carrega uma perna de Pix Troco.

key
string

A chave Pix do recebedor.

txId
string

Id de conciliação (idConciliacaoRecebedor).