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

recurrence
object
required

The embedded recurrence configuration (dadosRecorrencia).

recurrencePayloadUrl
string
required

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Example:

"pix.example.com/rec/abc"

certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Example:

"04358798"

txId
string

Conciliation id (idConciliacaoRecebedor).

Example:

"JDPI2024110800000000000000000000001"

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