Skip to main content
POST
Create a static composite PIX Automatico QR code

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
accountId
string
required

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

Example:

"acc-123"

jwkUrl
string
required

JWK Set URL (urlJwk; no scheme).

Example:

"example.com/pix/jwks"

key
string
required

The recipient PIX key the composite QR pays into.

Example:

"fulano.tal@provedor.com.br"

recurrence
object
required

The embedded recurrence configuration (dadosRecorrencia).

recurrencePayloadUrl
string
required

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Example:

"example.com/pix/rec/abc"

amount
integer<int64>

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

Example:

110001

certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Example:

"04358798"

description
string

Free-text additional data (dadosAdicionais).

Example:

"Conta de energia"

txId
string

Conciliation id (idConciliacaoRecebedor).

Example:

"TX-1"

zipCode
string

Recipient postal code (cep).

Example:

"01227200"

Response

Created

qrCode
string
required

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

Example:

"00020126..."

documentId
string

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

Example:

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

recurrencePayload
string

The signed recurrence JWS (payloadJwsRecorrencia).

Example:

"eyJhbGciOiJQUzUxMi..."