Skip to main content
POST
Criar QR code composto de Pix Automático dinâmico imediato

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 recebedor (fonte de nome + cidade).

jwkUrl
string
obrigatório

URL do JWK Set (urlJwk; sem esquema).

key
string
obrigatório

A chave Pix na qual o QR composto recebe.

originalAmount
number<double>
obrigatório

Valor original da cobrança em reais (valorOriginal).

paymentPayloadUrl
string
obrigatório

URL do host JWS de pagamento (urlPayloadJson; sem esquema).

recurrence
object
obrigatório
recurrencePayloadUrl
string
obrigatório

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

txId
string
obrigatório

Id de conciliação (idConciliacaoRecebedor).

certificateIspb
string

ISPB do certificado do PSP indireto (ispbCertificadoJws, string).

description
object[] | null

Entradas opcionais de dados adicionais (dadosAdicionais).

expirationTime
integer<int64>

Expiração do QR em segundos.

payer
object
zipCode
string

CEP do recebedor (cep).

Resposta

Criado

qrCode
string
obrigatório

A EMV composta-QR gerada (payload decodificado em base64, pronto para renderizar).

documentId
string

O id do documento da recorrência/cobrança (idDocumento, GUID).

recurrencePayload
string

O JWS de recorrência assinado (payloadJwsRecorrencia).