curl --location 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/recurrences' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
"responseFormat": "PAYLOAD_AND_QRCODE",
"city": "Sao Paulo",
"recurrenceId": "RN3822485720261027A1B2C3D4E5F",
"frequencyType": "MONTHLY",
"recurrenceStartDate": "2026-12-01",
"amount": 150.75,
"debtor": {
"type": "NATURAL",
"document": "12345678901",
"name": "Joao da Silva"
},
"contractNumber": "CTR-987654321",
"contractDescription": "Plano Premium",
"retry": "NOT_ALLOWED",
"beneficiaryConciliationId": "ADESAO-0001"
}'
{
"documentId": "01000000-3353-6e2c-12c9-08de9f179024",
"revision": "0",
"qrCodeImageBase64": "iVBORw0KGgoAAAANSUhEUgAAASQAAAEkAQAAAACugnFBAAAD60lEQVR4nO2a...",
"payloadBase64": "MDAwMjAxMjYxODAwMTRici5nb3YuYmNiLnBpeDUyMDQwMDAw...",
"payloadPix": "00020126180014br.gov.bcb.pix5204000053039865802BR5913SUA EMPRESA6009SAO PAULO...6304B85A",
"payloadJws": null,
"compositePayloadJws": null,
"recurrencePayloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjE0NzhFNDZB..."
}
{
"title": "Please refer to the errors property for additional details.",
"code": "INVALID_ARGUMENT",
"errors": ["contractNumber: must not be blank"]
}
Pix Automático
Criar QR Code de autorização
Cria um QR Code só com os dados da recorrência (jornada 2). O pagador lê e autoriza o Pix Automático.
POST
/
baas
/
api
/
v1
/
pix
/
qrcode
/
recurrences
curl --location 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/recurrences' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
"responseFormat": "PAYLOAD_AND_QRCODE",
"city": "Sao Paulo",
"recurrenceId": "RN3822485720261027A1B2C3D4E5F",
"frequencyType": "MONTHLY",
"recurrenceStartDate": "2026-12-01",
"amount": 150.75,
"debtor": {
"type": "NATURAL",
"document": "12345678901",
"name": "Joao da Silva"
},
"contractNumber": "CTR-987654321",
"contractDescription": "Plano Premium",
"retry": "NOT_ALLOWED",
"beneficiaryConciliationId": "ADESAO-0001"
}'
{
"documentId": "01000000-3353-6e2c-12c9-08de9f179024",
"revision": "0",
"qrCodeImageBase64": "iVBORw0KGgoAAAANSUhEUgAAASQAAAEkAQAAAACugnFBAAAD60lEQVR4nO2a...",
"payloadBase64": "MDAwMjAxMjYxODAwMTRici5nb3YuYmNiLnBpeDUyMDQwMDAw...",
"payloadPix": "00020126180014br.gov.bcb.pix5204000053039865802BR5913SUA EMPRESA6009SAO PAULO...6304B85A",
"payloadJws": null,
"compositePayloadJws": null,
"recurrencePayloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjE0NzhFNDZB..."
}
{
"title": "Please refer to the errors property for additional details.",
"code": "INVALID_ARGUMENT",
"errors": ["contractNumber: must not be blank"]
}
Para o passo a passo completo, veja o guia Jornada 2: QR Code de autorização.
Headers
string
required
Sua API key.
string
required
Número da conta Delfinance do recebedor.
Body
string
required
ONLY_PAYLOAD ou PAYLOAD_AND_QRCODE. Com PAYLOAD_AND_QRCODE, a resposta traz também a imagem em qrCodeImageBase64.string
required
Cidade do recebedor, até 15 caracteres. Os acentos são removidos.
string
Identificador da recorrência, com 29 caracteres. Se omitido, a API gera um, mas não o devolve na resposta. Veja o formato.
string
required
Periodicidade:
WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL ou ANNUAL.string
required
Data prevista da primeira cobrança, no formato
YYYY-MM-DD.string
Data final da recorrência, no formato
YYYY-MM-DD. Sem ela, a recorrência não tem prazo para acabar.number
Valor fixo de cada cobrança. Não envie junto com
minPayerMaxAmount.number
Para valor variável: o menor valor máximo que o pagador pode definir. Não envie junto com
amount.object
required
string
required
Identificador do contrato no seu sistema, até 35 caracteres. Aparece para o pagador.
string
Descrição curta exibida ao pagador, até 35 caracteres.
string
required
Política de retentativa:
NOT_ALLOWED ou ALLOWED (até 3 retentativas em 7 dias). Precisa bater com o 2º caractere do recurrenceId.string
required
Referência de conciliação. Hoje o valor não é devolvido em consultas nem webhooks.
Response
201 Created
string
Identificador do QR Code.
string
Revisão do QR Code. Começa em
0.string
Imagem PNG do QR Code em Base64.
null com ONLY_PAYLOAD.string
Payload Pix (EMV) em Base64.
string
Payload Pix em texto: o código Pix Copia e Cola.
string
Payload assinado da cobrança.
null nesta jornada, porque não há cobrança.string
Payload composto assinado, quando houver.
string
Payload assinado (JWS) da recorrência. O claim
idRec traz o recurrenceId.curl --location 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/recurrences' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
"responseFormat": "PAYLOAD_AND_QRCODE",
"city": "Sao Paulo",
"recurrenceId": "RN3822485720261027A1B2C3D4E5F",
"frequencyType": "MONTHLY",
"recurrenceStartDate": "2026-12-01",
"amount": 150.75,
"debtor": {
"type": "NATURAL",
"document": "12345678901",
"name": "Joao da Silva"
},
"contractNumber": "CTR-987654321",
"contractDescription": "Plano Premium",
"retry": "NOT_ALLOWED",
"beneficiaryConciliationId": "ADESAO-0001"
}'
{
"documentId": "01000000-3353-6e2c-12c9-08de9f179024",
"revision": "0",
"qrCodeImageBase64": "iVBORw0KGgoAAAANSUhEUgAAASQAAAEkAQAAAACugnFBAAAD60lEQVR4nO2a...",
"payloadBase64": "MDAwMjAxMjYxODAwMTRici5nb3YuYmNiLnBpeDUyMDQwMDAw...",
"payloadPix": "00020126180014br.gov.bcb.pix5204000053039865802BR5913SUA EMPRESA6009SAO PAULO...6304B85A",
"payloadJws": null,
"compositePayloadJws": null,
"recurrencePayloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjE0NzhFNDZB..."
}
{
"title": "Please refer to the errors property for additional details.",
"code": "INVALID_ARGUMENT",
"errors": ["contractNumber: must not be blank"]
}