Skip to main content
POST
Create an immediate dynamic composite PIX Automatico QR code

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
accountId
string
obrigatório

The CRM account id of the recipient (sources name + city).

Exemplo:

"acc-123"

jwkUrl
string
obrigatório

JWK Set URL (urlJwk; no scheme).

Exemplo:

"example.com/jwks"

key
string
obrigatório

The recipient PIX key the composite QR pays into.

Exemplo:

"fulano.tal@provedor.com.br"

originalAmount
integer<int64>
obrigatório

Original charge amount in centavos (valorOriginal).

Exemplo:

100001

paymentPayloadUrl
string
obrigatório

Payment JWS host URL (urlPayloadJson; no scheme).

Exemplo:

"pix.example.com/cob/abc"

recurrence
object
obrigatório

The embedded recurrence configuration (dadosRecorrencia).

recurrencePayloadUrl
string
obrigatório

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Exemplo:

"pix.example.com/rec/def"

txId
string
obrigatório

Conciliation id (idConciliacaoRecebedor).

Exemplo:

"JDPI2020010300000000000000000000001"

certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Exemplo:

"04358798"

description
object[] | null

Optional additional-data entries (dadosAdicionais).

expirationTime
integer<int64>

QR expiration in seconds (0 = JDPI default).

Exemplo:

86400

payer
object

Optional payer block.

zipCode
string

Recipient postal code (cep).

Exemplo:

"01227200"

Resposta

Created

qrCode
string
obrigatório

The generated EMV composite-QR payload (base64-decoded, ready to render).

Exemplo:

"00020126..."

documentId
string

The recurrence/charge document id (idDocumento, GUID).

Exemplo:

"52c43361-caa1-4ddb-9152-708426a25db3"

recurrencePayload
string

The signed recurrence JWS (payloadJwsRecorrencia).

Exemplo:

"eyJhbGciOiJQUzUxMi..."