Decode QR Code for Automatic PIX

Request

ENDPOINT

/account/ACCOUNT_KEY/qrcode/decode

METHOD

POST

Request Path Params

Field	Type	Description	Characters
account_key *	uuid4	Unique account identification key.	36

Request Body

Request Body: Decode 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

Field	Type	Description	Characters
qr_code_payload *	string	PIX Copy and Paste URL	-

Response

STATUS

200

Response Body: Decoded QR

{
    "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"
        }
    }
}

Field	Type	Description	Max. Characters
end_to_end_id	string	Idempotency key for a PIX transaction within the SPI (Instant Payment System). This key is returned when querying PIX keys.	32
qr_code_payload	string	PIX Copy and Paste URL
qr_code_key	uuid4	Unique QR code identification key	36
qr_code_data	Object	QR code data	qr_code_data Object

qr_code_data Object

Field	Type	Description	Characters
incoming_recurrence	object	Recurrence identification object	incoming_recurrence Object
payment_data	object	Object with payment information for journey_types: j3_payment_and_recurrence_qrcode, j4_recurrence_offer_post_payment	payment_data Object

incoming_recurrence Object

Field	Type	Description	Characters
incoming_recurrence_key	uuid4	Unique authorization identification key	36
incoming_recurrence_status	string	Recurrence status identifier	incoming_recurrence_status Enumerator
request_control_key	uuid4	Unique request identification key used by the client	36
transaction_amount	number	Transfer amount for fixed value occurrence.	10
minimum_transaction_amount	number	Minimum transfer amount for variable value occurrence.	10
maximum_transaction_amount	number	Maximum transfer amount for variable value occurrence.	10
periodicity	enumerator	Type of periodicity associated with the payment	periodicity Enumerators
journey_type	enumerator	Type of request journey	journey_type Enumerators
end_to_end_id	string	Idempotency key for a PIX transaction within the SPI (Instant Payment System). This key is returned when querying PIX keys.	32
start_date	string	Recurrence start date	-
end_date	string	Recurrence end date, for indefinite time cases, send as null
next_execution_date	string	Execution date for the next recurrence transaction	-
receiver_conciliation_id	string	Receiver reconciliation identification.	35
target_pix_key	string	PIX key for the transaction account.	100
is_retry_allowed	boolean	Permission for PIX transaction retry.	-
payer_document_number	string	Transaction payer document number.	14
payer_name	string	Transaction payer name.	-
payer_account_key	string	Transaction payer account identifier.	-
pix_message	string	Message to be sent along with the PIX transfer.	140
created_at	string	Recurrence request creation time	-

payment_data Object

Field	Type	Description	Characters
request_control_key	uuid4	Unique request identification key used by the client	36
transaction_amount	number	Transfer amount for fixed value occurrence.	10
target_pix_key	string	PIX key for the transaction account.	100
target_account	Object	Destination account for manual transfers.	target_account Object
receiver_conciliation_id	string	Receiver reconciliation identification.	35
pix_message	string	Message to be sent along with the PIX transfer.	140

target_account Object

Field	Type	Description	Characters
account_branch	string	Account branch.	6
account_digit	string	Account digit.	1
account_number	string	Account number.	20
owner_document_number	string	CPF or CNPJ (numbers only) of the account holder.	14
owner_name	string	Account holder name.	150
account_type	enumerator	Account type.	account_type Enumerator
ispb	string	Based on the financial institution's CNPJ (8 digits).	8

info

Different enumerators may represent the same account type due to information returned by different institutions.

account_type Enumerator

Enumerator	Description
checking_account	Checking Account
salary_account	Salary Account
saving_account	Savings Account
payment_account	Payment Account

incoming_recurrence_status Enumerator

Enumerator	Description
pending_confirmation	Recurrence pending confirmation
active	Active recurrence
cancelled	Cancelled recurrence
suspended	Suspended recurrence
expired	Expired recurrence

periodicity Enumerators

Enumerator	Description
weekly	Weekly recurrence
monthly	Monthly recurrence
quarterly	Quarterly recurrence
semiannual	Semiannual recurrence
annual	Annual recurrence

journey_type Enumerators

Enumerator	Description
j1_in_app_only_recurrence	Authorization request through an in-app notification
j2_recurrence_only_qrcode	Authorization request through QR Code reading
j3_payment_and_recurrence_qrcode	Recurrence authorization through an immediate PIX by reading a QR Code
j4_recurrence_offer_post_payment	PIX payment or scheduling with a subsequent recurrence authorization request

pix_transfer_type Enumerators

Enumerator	Description
manual	PIX using destination account data
key	PIX using a PIX key
static_qr_code	PIX using a static QR code
dynamic_qr_code	PIX using a dynamic QR code

STATUS

4XX

Response Body

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

HTTP Code	QI Code code	Title title	Description (eng) Description	Description (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.