Decodificação de QR Codes

O endpoint de decodificação do Bankly está preparado para ler QR Codes estáticos e dinâmicos gerados por qualquer instituição financeira.

📘
Nota
Os QR Codes dinâmicos podem destinar-se a pagamentos imediatos e futuros (com vencimento).

Ao decodificar um QR Code Pix, você obterá:

O endToEndId, um identificador único gerado pelo Bacen que deve ser informado ao realizar o pagamento do QR Code;
A chave Pix;
O valor do pagamento, caso ele tenha sido adicionado em na geração do QR Code. No Bankly, o valor poderá ser alterado pelo pagador no momento de efetuar da transação.

🚧
Importante
Para fazer a leitura de um QR Code de pagamento, obrigatoriamente, o conteúdo deve ser enviado em base64.

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/pix/qrcodes/decode

--request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/pix/qrcodes/decode' \ 
--header 'Accept: application/json' \ 
--header 'Content-Type: application/json' \ 
--header 'api-version: 1.0' \ 
--header 'x-bkly-pix-user-id: {{clientDocument}}' \ 
--header 'x-correlation-id: {{GUID}}' \ 
--header 'Authorization: Bearer {{accessToken}}'  \ 
--data-raw '{
  "encodedValue": "MDAwMjAxMjY1ODAwMTRCUi5HT1YuQkNCLlBJWDAxMTQrNTUxMTk5OTk5OTk5NTIwNDAwMDA1MzAzOTg2NTQwNDEwLjAwNTgwMkJSNTkwOUZ1bGFubyBkZSBUYWw2MDA5U2FvIFBhdWxvNjEwODA1NDA5MDAwNjIwNzA1MDMqKio2MzA0QjE0Rg==",
  "cityCode": "3550308"
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`pix.qrcode.read`	Concede acesso para decodificar um QR Code.

Cabeçalhos (Headers)

Nome	Descrição	Especificação
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.	—
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.	—
`x-bkly-pix-user-id`	Obrigatório. Número do documento do usuário que está fazendo a requisição.	`^([0-9]{11}\|[A-Z0-9]{12}[0-9]{2})$`
`x-correlation-id`	Se desejar, informe um GUID v4, sendo um novo cada requisição.	—

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`encodedValue`	`string`	Obrigatório. Conteúdo do QR Code em base64.
`cityCode`	`string`	Obrigatório. Código IBGE do município/cidade do endereço do pagador.

{ 
    "encodedValue": "{{yourEncode}}",
    "cityCode": "{{yourCityCode}}" 
}

Resposta (Response)

Os status code 200 indica que a solicitação foi aceita e que a decodificação do QR Code foi realizada com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`endToEndId`	`string`	Identificador único gerado pelo Bacen que deve ser informado ao realizar o pagamento do QR Code.
`conciliationId`	`string`	Identificador utilizado para conciliação dos pagamentos. Importante: este campo somente será retornado caso ele tenha sido enviado no momento da emissão do QR Code.
`addressingKey`	`object`	Objeto que contém informações sobre a chave de endereçamento.
`addressingKey.type`	`string`	Tipo de chave, que pode ser "CPF", "CNPJ", "PHONE", "EMAIL" ou "EVP".
`addressingKey.value`	`string`	Valor da chave.
`qrCodeType`	`string`	Informa se o QR Code é estático ("STATIC") ou dinâmico ("DYNAMIC").
`payer`	`object`	Objeto que contém informações sobre o pagador da transação. Este campo retorna apenas em caso de leitura de QR Code dinâmico.
`payer.name`	`string`	Nome do pagador da transação.
`payer.documentNumber`	`string`	Número do documento do pagador.
`payer.type`	`string`	Tipo de cliente pagador, que pode ser "CUSTOMER" ou "BUSINESS".
`payer.address`	`object`	Objeto que contém os dados de endereço.
`payer.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`payer.address.state`	`string`	Sigla do estado brasileiro conforme a ISO 3166-2:BR. Exemplo: SP.
`payer.address.city`	`string`	Nome da cidade. O valor máximo é de 15 caracteres para esse campo.
`payer.address.zipCode`	`string`	Código postal do endereço.
`holder`	`object`	Objeto que contém informações sobre o titular da conta a ser utilizada na transação.
`holder.type`	`string`	Tipo de titular, que pode ser "CUSTOMER" ou "BUSINESS".
`holder.name`	`string`	Nome do titular.
`holder.socialName`	`string`	Nome pelo qual a pessoa deseja ser chamada.
`holder.tradingName`	`string`	Nome comercial (nome fantasia) da empresa. Esse campo é retornado apenas quando o Person é Pessoa Jurídica.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo de documento do titular da conta, que pode ser "CPF" ou "CNPJ".
`bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`bank.name`	`string`	Nome do banco. Este campo retorna apenas em caso de leitura de QR Code estático.
`bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. Este campo retorna apenas em caso de leitura de QR Code dinâmico.
`payment`	`object`	Objeto que contém informações sobre o pagamento a ser realizado.
`payment.baseValue`	`number`	Valor de base.
`payment.interestValue`	`number`	Valor de juros.
`payment.penaltyValue`	`number`	Valor de multa.
`payment.discountValue`	`number`	Valor do desconto.
`payment.reductionValue`	`number`	Valor do abatimento.
`payment.totalValue`	`number`	Indica o valor do total da compra ou transferência.
`payment.dueDate`	`string`	Data de vencimento do pagamento, no formato ISO 8601.
`payment.changeValue`	`number`	Indica o valor do troco em espécie. Este campo somente é retornado em caso de decodificação de QR Code para Pix Troco.
`payment.withdrawalValue`	`number`	Indica o valor do saque em espécie. Este campo somente é retornado em caso de decodificação de QR Code para Pix Saque.
`payment.qrCodeChangeAmountType`	`string`	Indica a possibilidade de alteração do valor do QR Code. Se esse campo retornar "ALLOWED", será permitido alterar o valor. Caso o retorno seja "NOT_ALLOWED", não será permitido realizar a alteração do valor trazido pelo QR Code.
`location`	`object`	Objeto que contém informações sobre a localidade do recebedor da transação.
`location.city`	`string`	Nome da cidade do recebedor da transação.
`location.zipCode`	`string`	Código postal do recebedor da transação. Este campo retorna apenas na leitura de QR Codes dinâmicos.
`additionalData`	`array of objects`	Lista contendo um ou mais subcampos, criados pelo emissor, para descrever informações adicionais
`additionalData.name`	`string`	Campo livre para informações adicionais.
`additionalData.value`	`string`	Campo livre para informações adicionais.
`withdrawalDetail`	`object`	Objeto que contém informações referentes à decodificação de QR Code para Pix Saque.
`withdrawalDetail.changeAmountType`	`string`	Indica a possibilidade de alteração do valor do QR Code. Se esse campo retornar "ALLOWED", será permitido alterar o valor. Caso o retorno seja "NOT_ALLOWED", não será permitido realizar a alteração do valor trazido pelo QR Code.
`withdrawalDetail.agentType`	`string`	Especifica o tipo de estabelecimento comercial que está fornecendo o saque, que pode ser "STORE" ou "OTHER_BUSINESSES".
`withdrawalDetail.providerIspb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco provedor.
`changeAmountDetail`	`object`	Objeto que contém informações referentes à decodificação de QR Code para Pix Troco.
`changeAmountDetail.changeAmountType`	`string`	Indica a possibilidade de alteração do valor do QR Code. Se esse campo retornar "ALLOWED", será permitido alterar o valor. Caso o retorno seja "NOT_ALLOWED", não será permitido realizar a alteração do valor trazido pelo QR Code.
`changeAmountDetail.agentType`	`string`	Especifica o tipo de estabelecimento comercial que está fornecendo o troco, que pode ser "STORE" ou "OTHER_BUSINESSES".
`qrCodePurpose`	`string`	Razão da emissão do QR Code, que pode ser "PURCHASE_OR_TRANSFER" (compra ou transferência), "CHANGE" (para Pix Troco) ou "WITHDRAWAL" (para Pix Saque).
`allowsScheduling`	`booleano`	Este campo indica se o pagamento pode ser agendado. O agendamento é permitido para QR Code Estático e para cobranças com vencimento, desde que, para este último caso, a data do decode seja anterior à data de vencimento. O agendamento não é permitido para cobranças cujo vencimento seja igual ou anterior à data do decode, para pagamentos de Pix Saque e Pix Troco, nem para cobranças imediatas, que não possuem prazo para agendamento. Obs.: Este campo não será retornado quando se tratar de QR Code de Pix Automático – jornada 2.
`schedulingMaxDate`	`string`	Este campo define a data limite para a realização de um agendamento, sendo aplicável apenas quando o agendamento é permitido. Quando o agendamento for permitido e o QR Code não for estático, a data de vencimento será o limite final para o agendamento. Se o agendamento não for permitido ou não houver uma data máxima definida (como no caso de QR Code estático), este campo não será retornado. Data no formato ISO 8601. Obs.: Este campo não será retornado para QR Codes de Pix Automático – jornada 2.
`allowsRecurrence`	`booleano`	Este campo indica se o pagamento permite recorrência. A recorrência é permitida para pagamentos realizados por meio de iniciação via QR Code Estático. Por outro lado, a recorrência não é permitida em cobranças imediatas e em cobranças com vencimento, pois a natureza desses pagamentos não suporta recorrência. Obs.: Este campo não será retornado para QR Codes de Pix Automático – jornada 2.
`recurrence`	`object`	Objeto retornado apenas em caso de recorrência de pagamento via Pix Automático.
`recurrence.id`	`string`	Identificador da recorrência de pagamento via Pix automático.
`recurrence.retryPolicy`	`string`	Política de retentativa de pagamento após vencimento da recorrência, que pode ser ALLOW_3R_7D ou DOES_NOT_ALLOW.
`recurrence.contract`	`string`	Número do contrato atrelado à autorização de recorrência de pagamento via Pix Automático.
`recurrence.description`	`string`	Descrição do serviço/produto associado à recorrência.
`recurrence.initialDate`	`string`	Data estimada do primeiro pagamento recorrente via Pix automático, no formato ISO 8601 - UTC.
`recurrence.finalDate`	`string`	Data do último pagamento recorrente via Pix automático, no formato ISO 8601 - UTC.
`recurrence.frequency`	`string`	Periodicidade do pagamento recorrente via Pix automático, a qual pode ser WEEK (semanal), MNTH (mensal), QURT (trimestral), MIAN (semestral) e YEAR (anual)
`recurrence.amount`	`object`	Objeto que contém o valor da recorrência de pagamento.
`recurrence.amount.value`	`number`	Campo retornado apenas quando o valor do pagamento for fixo ou não for sujeito à alteração durante a vigência da autorização pagamento recorrente via Pix automático. Quando esse campo vier preenchido, o campo `recurrence.minimumAmount.value` virá nulo.
`recurrence.amount.currency`	`string`	Código da moeda. Ex.: BRL
`recurrence.minimumAmount`	`object`	Objeto que contém o valor da recorrência de pagamento.
`recurrence.minimumAmount.value`	`number`	Valor mínimo autorizado para o pagamento via Pix automático. Esse valor é definido pelo usuário recebedor. Caso esse campo venha preenchido, o campo `recurrence.amount.value` não estará preenchido
`recurrence.minimumAmount.currency`	`string`	Código da moeda. Ex.: BRL
`recurrence.payer`	`object`	Objeto que contém informações sobre o devedor do pagamento recorrente via Pix automático.
`recurrence.payer.documentNumber`	`string`	Documento do usuário, o quel pode ser CPF ou CNPJ.
`recurrence.payer.name`	`string`	Nome do pagador.
`recurrence.payer.type`	`string`	Tipo de pagador, que pode ser "CUSTOMER" ou "BUSINESS".
`recurrence.recipient`	`object`	Objeto que contém informações sobre o recebedor do pagamento recorrente via Pix automático.
`recurrence.recipient.holder`	`object`	Objeto que contem informações sobre o titular da conta que será o recebedor dos pagamentos recorrentes.
`recurrence.recipient.holder.documentNumber`	`string`	CNPJ do usuário recebedor.
`recurrence.recipient.holder.name`	`string`	Nome do recebedor.
`recurrence.recipient.holder.type`	`string`	Tipo de recebedor, que pode ser "CUSTOMER" ou "BUSINESS"?
`recurrence.recipient.bank`	`object`	Objeto que contem os dados do banco recebedor.
`recurrence.recipient.bank.ispb`	`string`	Número do ISPB do banco recebedor.
`recurrence.update`	`array of objects`	Lista de objetos que contém as datas de atualização da recorrência de pagamento.
`recurrence.update.status`	`string`	Status da recorrência de pagamento, que pode ser PENDING, APPROVED, CANCELED, EXPIRED, REJECTED, ERROR ou COMPLETED.
`recurrence.update.date`	`string`	Data e hora do registro de status atualizado. Respeita RFC 3339.
`recurrence.authorizationType`	`string`	Tipo da jornada da autorização de recorrência de pagamento via Pix automático, que pode ser AUT2, AUT3 ou AUT4.

🚧
Importante
Para fazer um pagamento Pix por QR Code, você precisará repassar os valores dos campos endToEndId e conciliationId retornados nesta API. O conciliationId será requerido para pagamento de QR Code dinâmico.

{
    "endToEndId": "E131400882021210234719976289315",
    "conciliationId": "12345",
    "addressingKey": {
        "type": "EVP",
        "value": "721f7f5-9227-411b-9297-c5ded2e7diii"
    },
    "qrCodeType": "STATIC",
    "holder": {
        "type": "BUSINESS",
        "name": "Editora Floresta",
        "document": {
            "value": "34183937000161",
            "type": "CNPJ"
        }
    },
    "bank": {
        "name": "Acesso Soluções De Pagamento S.A."
    },
    "payment": {
        "baseValue": 0.0,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
      	"reductionValue": 0.0,
        "totalValue": 1.00,
        "dueDate": "2021-11-29T23:59:59",
        "changeValue": 0.0,
        "withdrawalValue": 0.0
    },
    "location": {
        "city": "Santarém",
        "zipCode": "68060100"
    },
    "qrCodePurpose": "PURCHASE_OR_TRANSFER",
    "allowsScheduling": true,
    "allowsRecurrence": true
}

{
    "endToEndId": "E1314008820231114172019088054345",
    "conciliationId": "2279e2a1a6e446b18cecf13f0",
    "addressingKey": {
        "type": "EVP",
        "value": "4004901d-bd85-4769-8e52-cb4c42c506dc"
    },
    "qrCodeType": "STATIC",
    "holder": {
        "type": "BUSINESS",
        "name": "Editora Floresta",
        "document": {
            "value": "34183937000161",
            "type": "CNPJ"
        }
    },
    "bank": {
        "ispb": "99999008"
    },
    "payment": {
        "baseValue": 0.0,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
        "totalValue": 408.07,
        "dueDate": "0001-01-01T00:00:00",
        "changeValue": 0.0,
        "withdrawalValue": 408.07,
        "isSinglePayment": false,
        "qrCodeChangeAmountType": "NOT_ALLOWED"
    },
    "location": {
        "city": "Santarém"
    },
    "additionalData": [
        {
            "name": "",
            "value": "Jornada pagador 20151"
        }
    ],
    "withdrawalDetail": {
        "changeAmountType": "NOT_ALLOWED",
        "agentType": "STORE",
        "providerIspb": "99999008"
    },
    "qrCodePurpose": "WITHDRAWAL",
    "allowsScheduling": false,
    "allowsRecurrence": false
}

{
    "endToEndId": "E1314008820211210235032867394226",
    "conciliationId": "af7a357fe37b40be88a83f0f04650638",
    "addressingKey": {
        "type": "EVP",
        "value": "4004901d-bd85-4769-8e52-cb4c42c506dc"
    },
    "qrCodeType": "DYNAMIC",
    "payer": {
        "type": "CUSTOMER",
        "name": "Editora FLoresta",
        "document": {
            "value": "34183937000161",
            "type": "CNPJ"
        }
    },
    "holder": {
        "type": "BUSINESS",
        "name": "Company name",
        "document": {
            "value": "***111110001**",
            "type": "CNPJ"
        }
    },
    "bank": {
        "ispb": "99999008"
    },
    "payment": {
        "baseValue": 957.39,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
      	"reductionValue": 0.0,
        "totalValue": 957.39,
        "dueDate": "0001-01-01T00:00:00",
        "changeValue": 0.0,
        "withdrawalValue": 0.0
    },
    "location": {
        "city": "Santarém"
    },
    "additionalData": [
        {
            "name": "Entrega",
            "value": "Residencial"
        }
    ],
    "qrCodePurpose": "PURCHASE_OR_TRANSFER",
    "allowsScheduling": false,
    "allowsRecurrence": false
}

{
    "endToEndId": "E1314008820231114171927102983378",
    "conciliationId": "361b0473f5714e3dbba1a48ceb26e9a0",
    "addressingKey": {
        "type": "EVP",
        "value": "4004901d-bd85-4769-8e52-cb4c42c506dc"
    },
    "qrCodeType": "DYNAMIC",
    "payer": {
        "type": "CUSTOMER",
        "name": "Nísia Floresta",
        "document": {
            "value": "47742663023",
            "type": "CPF"
        }
    },
    "holder": {
        "type": "BUSINESS",
        "name": "Editora Floresta",
        "document": {
            "value": "34183937000161",
            "type": "CNPJ"
        }
    },
    "bank": {
        "ispb": "99999008"
    },
    "payment": {
        "baseValue": 0.00,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
        "totalValue": 283.94,
        "dueDate": "2021-11-29T23:59:59",
        "changeValue": 0.0,
        "withdrawalValue": 283.94,
        "isSinglePayment": false,
        "qrCodeChangeAmountType": "NOT_ALLOWED"
    },
    "location": {
        "city": "Santarém"
    },
    "additionalData": [
        {
            "name": "Entrega",
            "value": "Residencial"
        }
    ],
    "withdrawalDetail": {
        "changeAmountType": "NOT_ALLOWED",
        "agentType": "WITHDRAWAL_PROVIDER",
        "providerIspb": "99999008"
    },
    "qrCodePurpose": "WITHDRAWAL",
    "allowsScheduling": false,
    "allowsRecurrence": false
}

{
    "endToEndId": "E1314008820231114172109516637904",
    "conciliationId": "00775d7611e94305920392ae1ccff480",
    "addressingKey": {
        "type": "EVP",
        "value": "4004901d-bd85-4769-8e52-cb4c42c506dc"
    },
    "qrCodeType": "DYNAMIC",
    "payer": {
        "type": "CUSTOMER",
        "name": "Nísia floresta",
        "document": {
            "value": "47742663023",
            "type": "CPF"
        }
    },
    "holder": {
        "type": "BUSINESS",
        "name": "Editora Floresta",
        "document": {
            "value": "34183937000161",
            "type": "CNPJ"
        }
    },
    "bank": {
        "ispb": "99999008"
    },
    "payment": {
        "baseValue": 839.01,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
        "totalValue": 1773.88,
        "dueDate": "2021-11-09T23:59:59",
        "changeValue": 934.87,
        "withdrawalValue": 0.0,
        "isSinglePayment": false,
        "qrCodeChangeAmountType": "NOT_ALLOWED"
    },
    "location": {
        "city": "Santarém"
    },
    "additionalData": [
        {
            "name": "Entrega",
            "value": "Residencial"
        }
    ],
    "changeAmountDetail": {
        "changeAmountType": "NOT_ALLOWED",
        "agentType": "STORE",
        "providerIspb": "99999008"
    },
    "qrCodePurpose": "CHANGE_AMOUNT",
    "allowsScheduling": false,
    "allowsRecurrence": false
}

{
    "endToEndId": "E1314008820211210235723815730157",
    "conciliationId": "c4164f64f8f849cb80b5b01cf9a31b85",
    "addressingKey": {
        "type": "EVP",
        "value": "4004901d-bd85-4769-8e52-cb4c42c506dc"
    },
    "qrCodeType": "DYNAMIC",
    "payer": {
        "type": "CUSTOMER",
        "name": "Editora Floresta",
        "document": {
            "value": "34183937000161",
            "type": "CNPJ"
        }
    },
    "holder": {
        "type": "CUSTOMER",
        "name": "Nísia Floresta",
        "tradingName": "QR Codes Pix",
        "document": {
            "value": "47742663023",
            "type": "CPF"
        }
    },
    "bank": {
        "ispb": "99999008"
    },
    "payment": {
        "baseValue": 110.71,
        "interestValue": 20.00,
        "penaltyValue": 5.00,
        "discountValue": 0.0,
      	"reductionValue": 0.0,
        "totalValue": 135.71,
        "dueDate": "2021-11-29T23:59:59",
        "changeValue": 0.0,
        "withdrawalValue": 0.0
    },
    "additionalData": [
        {
            "name": "Multa por valor fixo",
            "value": "5.00"
        },
        {
            "name": "Juros absolutos por dias corridos",
            "value": "2.00"
        }
    ],
    "qrCodePurpose": "PURCHASE_OR_TRANSFER",
    "allowsScheduling": true,
    "schedulingMaxDate": "2021-11-29T23:59:59",
    "allowsRecurrence": false
}

{
    "qrCodeType": "DYNAMIC",
    "qrCodePurpose": "RECURRENCE",
    "recurrence": {
        "id": "RR999999182025071027480933429",
        "contract": "11617044",
        "initialDate": "2025-07-10T00:00:00",
        "frequency": "MNTH",
        "retryPolicy": "ALLOW_3R_7D",
        "authorizationType": "AUT2",
        "amount": {
            "value": 849.57,
            "currency": "BRL"
        },
        "payer": {
            "documentNumber": "13140088000199",
            "name": "ACESSO SOLUCOES PAGAMENTO SA",
            "type": "CUSTOMER"
        },
        "description": "Serviço de Streaming de vídeo",
        "recipient": {
            "holder": {
                "documentNumber": "99999918999924",
                "name": "Pix Tester 918",
                "type": "BUSINESS"
            },
            "bank": {
                "ispb": "99999918"
            }
        },
        "update": [
            {
                "date": "2025-07-10T00:00:00Z",
                "status": "CREATED"
            }
        ]
    }
}

{
    "qrCodeType": "DYNAMIC",
    "qrCodePurpose": "RECURRENCE",
    "recurrence": {
        "id": "RR999999182025071027480933429",
        "contract": "11617044",
        "initialDate": "2025-07-10T00:00:00",
        "frequency": "MNTH",
        "retryPolicy": "ALLOW_3R_7D",
        "authorizationType": "AUT2",
        "amount": {
            "value": 849.57,
            "currency": "BRL"
        },
        "minimumAmount": {
            "value": 49.57,
            "currency": "BRL"
        },
        "payer": {
            "documentNumber": "13140088000199",
            "name": "ACESSO SOLUCOES PAGAMENTO SA",
            "type": "CUSTOMER"
        },
        "description": "Serviço de Streaming de vídeo",
        "recipient": {
            "holder": {
                "documentNumber": "99999918999924",
                "name": "Pix Tester 918",
                "type": "BUSINESS"
            },
            "bank": {
                "ispb": "99999918"
            }
        },
        "update": [
            {
                "date": "2025-07-10T00:00:00Z",
                "status": "CREATED"
            }
        ]
    }
}

{
    "endToEndId": "E131400882025071017565583C4D97A5",
    "conciliationId": "d8aa33b8f0a941709ced9fa5270b42c8",
    "addressingKey": {
        "type": "EVP",
        "value": "f4c6089a-bfde-4c00-a2d9-9eaa584b0219"
    },
    "qrCodeType": "DYNAMIC",
    "holder": {
        "type": "BUSINESS",
        "name": "Pix Tester 99999918",
        "tradingName": "Pix Tester 99999918",
        "document": {
            "value": "99999918999924",
            "type": "CNPJ"
        }
    },
    "bank": {
        "ispb": "99999918"
    },
    "payment": {
        "baseValue": 410.51,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
        "reductionValue": 0.0,
        "totalValue": 410.51,
        "dueDate": "2021-11-29T23:59:59",
        "changeValue": 0.0,
        "withdrawalValue": 0.0,
        "isSinglePayment": false,
        "qrCodeChangeAmountType": "NOT_ALLOWED"
    },
    "location": {
        "city": "",
        "zipCode": ""
    },
    "additionalData": [
        {
            "name": "Entrega",
            "value": "Residencial"
        }
    ],
    "qrCodePurpose": "PURCHASE_OR_TRANSFER",
    "recurrence": {
        "id": "RR999999182025071097805915604",
        "contract": "5088459",
        "initialDate": "2025-07-10T00:00:00",
        "frequency": "MNTH",
        "retryPolicy": "ALLOW_3R_7D",
        "authorizationType": "AUT3",
        "amount": {
            "value": 703.98,
            "currency": "BRL"
        },
        "payer": {
            "documentNumber": "13140088000199",
            "name": "ACESSO SOLUCOES PAGAMENTO SA",
            "type": "CUSTOMER"
        },
        "description": "Serviço de Academia",
        "recipient": {
            "holder": {
                "documentNumber": "99999918999924",
                "name": "Pix Tester 918",
                "type": "BUSINESS"
            },
            "bank": {
                "ispb": "99999918"
            }
        },
        "update": [
            {
                "date": "2025-07-10T00:00:00Z",
                "status": "CREATED"
            }
        ]
    },
    "allowsScheduling": false,
    "allowsRecurrence": false
}

{
    "endToEndId": "E1314008820250710175701530D89F30",
    "conciliationId": "d745bf9714f04204829e011bc",
    "addressingKey": {
        "type": "EVP",
        "value": "f4c6089a-bfde-4c00-a2d9-9eaa584b0219"
    },
    "qrCodeType": "STATIC",
    "holder": {
        "type": "BUSINESS",
        "name": "Pix Tester 99999918",
        "tradingName": "Pix Tester 99999918",
        "document": {
            "value": "99999918999924",
            "type": "CNPJ"
        }
    },
    "bank": {
        "ispb": "99999918"
    },
    "payment": {
        "baseValue": 200.06,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
        "reductionValue": 0.0,
        "totalValue": 200.06,
        "changeValue": 0.0,
        "withdrawalValue": 0.0,
        "isSinglePayment": false,
        "qrCodeChangeAmountType": "NOT_ALLOWED"
    },
    "location": {
        "city": "",
        "zipCode": ""
    },
    "qrCodePurpose": "PURCHASE_OR_TRANSFER",
    "recurrence": {
        "id": "RR999999182025071051818511094",
        "contract": "66053381",
        "initialDate": "2025-07-10T00:00:00",
        "frequency": "MNTH",
        "retryPolicy": "ALLOW_3R_7D",
        "authorizationType": "AUT4",
        "amount": {
            "value": 675.33,
            "currency": "BRL"
        },
        "payer": {
            "documentNumber": "13140088000199",
            "name": "ACESSO SOLUCOES PAGAMENTO SA",
            "type": "CUSTOMER"
        },
        "description": "Serviço de Plano de saúde",
        "recipient": {
            "holder": {
                "documentNumber": "99999918999924",
                "name": "Pix Tester 918",
                "type": "BUSINESS"
            },
            "bank": {
                "ispb": "99999918"
            }
        },
        "update": [
            {
                "date": "2025-07-10T00:00:00Z",
                "status": "CREATED"
            }
        ]
    },
    "allowsScheduling": true,
    "allowsRecurrence": true
}

{
    "endToEndId": "E1314008820250721181212C4BD1344F",
    "conciliationId": "9d332436a3ef466988fa9414a8d3dd61",
    "addressingKey": {
        "type": "EVP",
        "value": "f4c6089a-bfde-4c00-a2d9-9eaa584b0219"
    },
    "qrCodeType": "DYNAMIC",
    "holder": {
        "type": "BUSINESS",
        "name": "Pix Tester 99999918",
        "tradingName": "Pix Tester 99999918",
        "document": {
            "value": "99999918999924",
            "type": "CNPJ"
        }
    },
    "bank": {
        "ispb": "99999918"
    },
    "payment": {
        "baseValue": 121.69,
        "interestValue": 0.0,
        "penaltyValue": 0.0,
        "discountValue": 0.0,
        "reductionValue": 0.0,
        "totalValue": 121.69,
        "dueDate": "2025-07-20T23:59:59",
        "changeValue": 0.0,
        "withdrawalValue": 0.0,
        "isSinglePayment": false,
        "qrCodeChangeAmountType": "NOT_ALLOWED"
    },
    "location": {
        "city": "Brasilia",
        "zipCode": "70074900"
    },
    "qrCodePurpose": "PURCHASE_OR_TRANSFER",
    "recurrence": {
        "id": "RR999999182025071045620365322",
        "contract": "72791035",
        "initialDate": "2025-07-10T00:00:00",
        "frequency": "MNTH",
        "retryPolicy": "ALLOW_3R_7D",
        "authorizationType": "AUT4",
        "amount": {
            "value": 730.28,
            "currency": "BRL"
        },
        "payer": {
            "documentNumber": "13140088000199",
            "name": "ACESSO SOLUCOES PAGAMENTO SA",
            "type": "CUSTOMER"
        },
        "description": "Serviço de Academia",
        "recipient": {
            "holder": {
                "documentNumber": "99999918999924",
                "name": "Pix Tester 918",
                "type": "BUSINESS"
            },
            "bank": {
                "ispb": "99999918"
            }
        },
        "update": [
            {
                "date": "2025-07-10T00:00:00Z",
                "status": "CREATED"
            }
        ]
    },
    "allowsScheduling": true,
    "schedulingMaxDate": "2025-07-20T23:59:59",
    "allowsRecurrence": true
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

❗️
Se a instituição integradora (parceiro) não tiver implementado o Pix Automático, ao realizar o decode de um QR Code associado a qualquer uma das jornadas, o serviço retornará o erro QRCODE_CANNOT_BE_DECODED.
Esse erro ocorre porque a instituição não possui o escopo necessário para decodificar QR Codes do Pix Automático (pix.recurrence-payment-auth.write).

Este endpoint pode retornar alguns erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
400	QRCODE_CANNOT_BE_DECODED	The QrCodePayload is invalid or cannot be decoded. Check it out with the PSP.	O QR Code não pode ser decodificado.
403	QRCODE_CANNOT_BE_DECODED	This request is not enabled for automatic Pix, so this QR Code cannot be decoded. Check it out with the PSP.	O QR Code não pode ser decodificado pois pertence à uma jornada do Pix Automático.
400	INVALID_USER_ID	Ensure that the x-bkly-pix-user-id header is a valid CPF or CNPJ document.	Verifique se o cabeçalho `x-bkly-pix-user-id` apresenta um CPF ou CNPJ válido.
400	QRCODE_PAYLOAD_LOCATION_REMOVED	The QrCodePayload location was removed by PSP.	O QR Code não está mais disponível para leitura por ter sido removido pela PSP do recebedor.
400	REQUEST_NOT_ALLOWED_OUT_OF_BUSINESS_PERIOD	Request not not allowed out of business period.	Não está disponível fora do horário comercial.
400	ENTRY_NOT_FOUND	Entry not found.	A chave que está sendo usada para gerar o QR Code não existe.
400	CASHOUT_LIMIT_NOT_ENOUGH	Sender does not have sufficient cash out limit.	A transação excede o limite de valor da transferência.
408	REQUEST_TIMEOUT	Transaction exceeded request limit timeout.	A requisição excedeu o tempo limite da solicitação.
410	QRCODE_PAID_OR_EXPIRED	Error decode QRCode, bill has expired or it has already been paid.	Erro ao decodificar QR Code, a cobrança expirou ou já foi paga.
422	ENTRY_WITH_SUSPICION_OF_FRAUD	Account, user, or key linked to an account restricted due to substantiated suspicion of fraud.	Conta, usuário ou chave com suspeita fundamentada de fraude.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.