Skip to main content
POST
Create a static 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/pix/jwks"

key
string
obrigatório

The recipient PIX key the composite QR pays into.

Exemplo:

"fulano.tal@provedor.com.br"

recurrence
object
obrigatório

The embedded recurrence configuration (dadosRecorrencia).

recurrencePayloadUrl
string
obrigatório

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Exemplo:

"example.com/pix/rec/abc"

amount
integer<int64>

Amount in centavos (0 = any-amount static QR).

Exemplo:

110001

certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Exemplo:

"04358798"

description
string

Free-text additional data (dadosAdicionais).

Exemplo:

"Conta de energia"

txId
string

Conciliation id (idConciliacaoRecebedor).

Exemplo:

"TX-1"

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..."