Skip to main content
POST
Resolve a dynamic BR Code (payer side)

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Caller-Budget-Ms
integer<int64>

Milliseconds the whole resolve may take (location, JWK Set and revocation reads); once spent, the route answers 502 (no verdict). Omitted, each fetch is bounded at 5 s.

Required range: 100 <= x <= 15000

Body

application/json
raw
string
required

The scanned BR Code (or Pix Copia e Cola) of a dynamic QR.

Minimum string length: 1
codMun
string

cobv only: the payer's IBGE municipality code. Omit only when the account type gives the PSP no address.

Pattern: ^[0-9]{7}$
dpp
string<date>

cobv only: intended payment date (YYYY-MM-DD). Omitted, the receiver assumes the due date, or today once overdue.

Response

OK

amount
string
required

Amount as presented: valor.original + saque + troco (cob) or valor.final (cobv). With modalidadeAlteracao 1 the payer may change it.

calendario
object
required
chave
string
required
jws
string
required

The signed payload as served (JWS compact), kept as the payment's evidence.

kind
string
required

cob (immediate) or cobv (due date).

revisao
integer<int64>
required
signingChain
string[]
required

The verified JWS signing certificate chain, leaf first, each certificate base64 DER (as a JWK x5c). Keep it with the JWS: it carries the public key the signature verified against.

status
string
required
txid
string
required
valor
object
required
devedor
object
expiresAt
string<date-time>

cob only: calendario.criacao + calendario.expiracao.

infoAdicionais
object[] | null
recebedor
object
solicitacaoPagador
string