Skip to main content
POST
Decodificar QR code composto de Pix Automático a partir de sua URL

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

A URL do host JWS de recorrência a decodificar (urlPayloadJsonRec; sem esquema).

Resposta

OK

contractNumber
string
obrigatório

Identificador de contrato/pedido (nrContrato).

debtor
object
obrigatório
frequency
integer<int64>
obrigatório

tpFrequencia.

recipient
object
obrigatório
recurrenceId
string
obrigatório

Id único de recorrência.

retry
integer<int64>
obrigatório

política retentativa.

startDate
string
obrigatório

Data do primeiro pagamento (aaaa-mm-dd).

amount
number<double>

Valor fixo de pagamento em reais.

contractDesc
string

Descrição de contrato em texto livre.

createdDateTime
string

Data/hora de criação do QR (dtHrCriacao).

endDate
string

Data do último pagamento (aaaa-mm-dd).

maxFloorAmount
number<double>

Valor mínimo em reais (pisoValorMaximo).

presentedDateTime
string

Data/hora de apresentação do QR (dtHrApresentacao).

updates
object[] | null

Histórico de status da recorrência (atualizacoes).