Decodificar QR Code para Pix Automático

Request

ENDPOINT

/account/ACCOUNT_KEY/qrcode/decode

MÉTODO

POST

Request Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuid4	Chave única de identificação da conta.	36

Request Body

Request Body: Decodificar QR Code

{
    "qr_code_payload": "00020101021226840014br.gov.bcb.pix2562invoice.starkbank.com/v2/cobv/8b434df48c30482a81f7c936ae35cc87080400005303986540555.595802BR5925Stark Bank S.A.6015Sao Caetano do Sul62070503***80740014br.gov.bcb.pix2552pix.example.com/rec/2353c790eefb11eaadc10242ac120002630411FC"
}

Body Params

Campo	Tipo	Descrição	Caracteres
qr_code_payload *	string	URL do PIX Copia e Cola	-

Response

STATUS

200

Response Body: QR decodificado

{
    "end_to_end_id": "E32402502202303101532yCipbxgUnUj",
    "qr_code_payload": "00020101021226840014br.gov.bcb.pix2562invoice.starkbank.com/v2/cobv/8b434df48c30482a81f7c936ae35cc87080400005303986540555.595802BR5925Stark Bank S.A.6015Sao Caetano do Sul62070503***80740014br.gov.bcb.pix2552pix.example.com/rec/2353c790eefb11eaadc10242ac120002630411FC",
    "qr_code_key": "8c2c19bd-f260-4714-955c-956f3eaa30ca",
    "qr_code_type": "dynamic_composed",
    "qr_code_data": {
        "incoming_recurrence": {
            "incoming_recurrence_key": "67abc123-4567-89ab-cdef-1234567890ab",
            "journey_type": "j2_recurrence_only_qrcode",
            "incoming_recurrence_type": "variable_amount",
            "incoming_recurrence_status": "pending_confirmation",
            "start_date": "2024-08-01",
            "end_date": null,
            "periodicity": "weekly",
            "target_pix_key": "teste.recorrencia@email.com.br",
            "minimum_transaction_amount": "100.00",
            "maximum_transaction_amount": "500.00",
            "transaction_amount": null,
            "is_retry_allowed": true,
            "created_at": "2024-07-23T14:30:45.123Z",
            "payer_document_number": "12345678901",
            "payer_name": "João da Silva",
            "payer_account_key": "a5d7e60f-1c9b-4b8a-9de7-6f3b919cc45d",
            "request_control_key": "c7d7e60f-1c9b-4b8a-9de7-6f3b919cc45f",
            "receiver_conciliation_id": "RRAUTOTESTE001",
            "pix_message": "Autorização de débito mensal"
        },
        "payment_data": {
            "request_control_key": "c7d7e60f-1c9b-4b8a-9de7-6f3b919cc45f",
            "transaction_amount": "150.75",
            "target_pix_key": "teste.recorrencia@email.com.br",
            "target_account": null,
            "receiver_conciliation_id": "fgnb4NTt7pOUBGfrcporERwVVqr0f8PWRfK",
            "pix_message": "Assinatura mensal do serviço"
        }
    }
}

Campo	Tipo	Descrição	Max. Caracteres
end_to_end_id	string	Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo). Esta chave é retornada na consulta de chave Pix.	32
qr_code_payload	string	URL do PIX Copia Cola
qr_code_key	uuid4	Chave única de identificação do qr code	36
qr_code_data	Object	Dados dos qr code	Objeto qr_code_data

Objeto qr_code_data

Campo	Tipo	Descrição	Caracteres
incoming_recurrence	objeto	Objeto de identificação da recorrência	Objeto incoming_recurrence
payment_data	objeto	Objeto com informações de pagamento para journey_types: j3_payment_and_recurrence_qrcode, j4_recurrence_offer_post_payment	Objeto payment_data

Objeto incoming_recurrence

Campo	Tipo	Descrição	Caracteres
incoming_recurrence_key	uuid4	Chave única de identificação da autorização	36
incoming_recurrence_status	string	Identificador de status da recorrência	Enumerador incoming_recurrence_status
request_control_key	uuid4	Chave única de identificação da request utilizada pelo cliente	36
transaction_amount	number	Valor da transferência para ocorrência de valor fixo.	10
minimum_transaction_amount	number	Valor mínimo da transferência para ocorrência de valor variável.	10
maximum_transaction_amount	number	Valor máximo da transferência para ocorrência de valor valor variável.	10
periodicity	enumerator	Tipo da periodicidade associada ao pagamento	Enumeradores periodicity
journey_type	enumerator	Tipo da jornada de solicitação	Enumeradores journey_type
end_to_end_id	string	Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo). Esta chave é retornada na consulta de chave Pix.	32
start_date	string	Data de ínicio da recorrência	-
end_date	string	Data de término da recorrência, para os casos de tempo indeterminado, enviar como null
next_execution_date	string	Data de execução da próxima transação da recorrência	-
receiver_conciliation_id	string	Identicação de conciliação do recebedor.	35
target_pix_key	string	Chave pix da conta da transação.	100
is_retry_allowed	boolean	Permissão para retentativa de transação Pix.	-
payer_document_number	string	Número de documento do pagador da transação transação.	14
payer_name	string	Nome do pagador da transação transação.	-
payer_account_key	string	Identificador da conta do pagador da transação transação.	-
pix_message	string	Mensagem a ser enviada junto à transferência Pix.	140
created_at	string	Horário da criação da solicitação de recorrência	-

Objeto payment_data

Campo	Tipo	Descrição	Caracteres
request_control_key	uuid4	Chave única de identificação da request utilizada pelo cliente	36
transaction_amount	number	Valor da transferência para ocorrência de valor fixo.	10
target_pix_key	string	Chave pix da conta da transação.	100
target_account	Object	Conta destino em transferências manuais.	Objeto target_account
receiver_conciliation_id	string	Identicação de conciliação do recebedor.	35
pix_message	string	Mensagem a ser enviada junto à transferência Pix.	140

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch	string	Agência da conta.	6
account_digit	string	Dígito da conta.	1
account_number	string	Número da conta.	20
owner_document_number	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name	string	Nome do titular da conta.	150
account_type	enumerator	Tipo da conta.	Enumerador account_type
ispb	string	Base no CNPJ da instituição financeira (8 dígitos).	8

info

Diferentes enumeradores podem significar o mesmo tipo de conta devido a informação retornada por diferentes instituições.

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

Enumerador incoming_recurrence_status

Enumerador	Descrição
pending_confirmation	Recorrência pendente de confirmação
active	Recorrência ativa
cancelled	Recorrência cancelada
suspended	Recorrência suspensa
expired	Recorrência expirada

Enumeradores periodicity

Enumerador	Descrição
weekly	Recorrência semanal
monthly	Recorrência mensal
quarterly	Recorrência trimestral
semiannual	Recorrência semestral
annual	Recorrência anual

Enumeradores journey_type

Enumerador	Descrição
j1_in_app_only_recurrence	Solicitação de autorização mediante uma notificação no aplicativo
j2_recurrence_only_qrcode	Solicitação de autorização mediante a leitura de um QR Code
j3_payment_and_recurrence_qrcode	Autorização de recorrência por meio de um pix imediato mediante leitura de um QR Code
j4_recurrence_offer_post_payment	Pagamento ou agendamento de um pix com uma solicitação de autorização da recorrência em sequência

Enumeradores pix_transfer_type

Enumerador	Descrição
manual	Pix utilizando os dados da conta destino
key	Pix utilizando uma chave pix
static_qr_code	Pix utilizando um QR code estático
dynamic_qr_code	Pix utilizando um QR code dinâmico

STATUS

4XX

Response Body

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo"
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) translation
400	QIT000001	Bad Request	Schema Error	Erro de Schema
403	APX000025	User is not allowed to do this transaction	User is not allowed to do this transaction	Usuário não tem autorização para fazer essa transação
403	APX000017	Requester not allowed to access this endpoint	Requester has no permission to perform pix transfers on this endpoint	Requester não possui permissão de realizar transações pix através deste endpoint
404	APX000020	Account not Found	Account was not found	Conta {account_key} não foi encontrada.