Query Automatic Pix Recurrence Data by QRCode

Request

ENDPOINT

/account/ACCOUNT_KEY/outgoing_recurrence/qr_code_initial_payment/RECEIVER_CONCILIATION_ID

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key *	uuidv4	Unique account identification key.	36
receiver_conciliation_id*	string	Conciliation ID of the qr_code associated with the recurrence	32

Response

STATUS

200

Response Body

{
  "request_control_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
  "outgoing_recurrence_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "outgoing_recurrence_status": "approved",
  "periodicity": "monthly",
  "journey_type": "journey_four",
  "start_date": "2025-06-10",
  "end_date": "2027-06-10",
  "outgoing_recurrence_data": {
    "minimum_recurrence_amount": 123.45,
    "recurrence_amount": null,
    "retry_configuration": {
      "retry_allowed": true,
      "retry_rule": {
        "first_retry": {
          "day": "1"
        },
        "second_retry": {
          "day": "3"
        },
        "third_retry": {
          "day": "4"
        }
      }
    },
    "debtor_data": {
      "name": "Sebastião",
      "email": "sebastiao@test.com",
      "document_number": "05431134850",
      "address": {
        "city": "São Paulo",
        "postal_code": "123456-789",
        "uf": "SP",
        "street": "Av Paulista 123"
      },
      "account_data": {
        "account_number": "123456",
        "account_digit": "7",
        "account_branch": "0001",
        "ispb": "31872495"
      }
    },
    "qr_code_data": {
      "qr_code_key": "0f45cc3d-9bd1-4d68-a865-4cf477b5da45",
      "qr_code_url": "urlqrcode.url",
      "qr_code_image": "image_base64"
    },
    "initial_payment_data": {
      "amount": 22.34,
      "pix_key": "3d7d6a2b-f72f-44z7-bb20-79a94dff5645",
      "qr_code_type": "dynamic_term",
      "additional_data": [
        {
          "key_name": "Juros e Multa",
          "value": "Juros 2 ao mes e multa de 1%"
        }
      ],
      "fine_amount": 3,
      "interest_amount": 2,
      "expiration_date": "2023-03-25",
      "max_payment_days": 128,
      "rebate_amount": 1,
      "discounts": [],
      "receiver_conciliation_id":"3d7d6a2bf72f44z7bb2079a94dff5645",
      "transaction_data":{
        "transaction_key":"4d7d6a2b-f72f-44z7-bb20-79a94dff5645",
        "pix_transfer_key":"5d7d6a2b-f72f-44z7-bb20-79a94dff5645",
        "end_to_end_id":"E32402502202303141907qlBAF1evdJ2"
      }
    },
    "pix_message": "Conta de Luz Residencial nº123",
    "settlement_date_type": "calendar_days"
  }
}

Response Body Params

Field	Type	Description	Characters
request_control_key	uuidv4	Unique key for request control.	36
outgoing_recurrence_key	uuidv4	Automatic recurrence identifier.	36
outgoing_recurrence_status	string	Current recurrence status (approved, pending, rejected, etc.).	30
periodicity	enumerator	Recurrence periodicity.	periodicity Enumerators
journey_type	enumerator	Automatic recurrence journey.	journey_type Enumerators
start_date	string	Recurrence start date (ISO 8601 format, e.g., 2025-06-10).	10
end_date	string	Recurrence end date (ISO 8601 format) or null, if indefinite.	10 or null
outgoing_recurrence_data	object	Object grouping subscription parameters and complementary data.	outgoing_recurrence_data Object

---

outgoing_recurrence_data Object

Field	Type	Description	Characters
minimum_recurrence_amount	number	Minimum expected amount for variable amount recurrences	-
recurrence_amount	number	Recurrence amount (for fixed amount; null if variable)	-
retry_configuration	object	Configuration for attempts on uncompleted recurrences	retry_configuration Object
debtor_data	object	Debtor (subscriber) data	debtor_data Object
qr_code_data	object	QR Code data generated for payment (if any)	qr_code_data Object
initial_payment_data	object	Initial charge data	initial_payment_data Object
pix_message	string	Message sent with the Pix transaction	140
settlement_date_type	enumerator	Settlement date adjustment type	settlement_date_type Enumerators

---

retry_configuration Object

Field	Type	Description	Characters
retry_allowed	boolean	Indicates if retries are enabled	-
retry_rule	object	Detailed retry rules	retry_rule Object

---

retry_rule Object

Field	Type	Description	Characters
first_retry	object	Configuration for 1st retry	retry_detail Object
second_retry	object	Configuration for 2nd retry	retry_detail Object
third_retry	object	Configuration for 3rd retry	retry_detail Object

---

retry_detail Object

Field	Type	Description	Characters
day	string	Retry day.	-
time	string	Retry time.	-

---

debtor_data Object

Field	Type	Description	Characters
name	string	Subscriber name.	50
email	string	Subscriber email.	100
document_number	string	CPF or CNPJ.	14
address	object	Subscriber address.	address Object
account_data	object	Bank account data.	account_data Object

---

address Object

Field	Type	Description	Characters
city	string	City.	-
postal_code	string	Postal code.	-
uf	string	State (abbreviation).	-
street	string	Street address.	-

---

account_data Object

Field	Type	Description	Characters
account_number	string	Account number	-
account_digit	string	Account digit	-
account_branch	string	Branch	-
ispb	string	Financial institution ISPB	-

---

qr_code_data Object

Field	Type	Description	Characters
qr_code_key	string	Generated QR Code identifier	-
qr_code_url	string	URL for QR Code visualization	-
qr_code_image	string	QR Code image (in Base64)	-

---

initial_payment_data Object

Field	Type	Description	Characters
amount	number	Principal amount of the initial charge in reais (R$)	-
pix_key	string	Destination Pix key for initial payment	77
qr_code_type	enum	QR Code type for initial charge.	qr_code_type Enumerators
additional_data	array	List of additional information related to the charge	additional_data Array of objects
fine_amount	number	Fine amount, in case of payment delay	-
interest_amount	number	Interest amount, in case of payment delay	-
expiration_date	string	Initial charge expiration date (ISO 8601 format)	10
max_payment_days	integer	Maximum number of acceptance days after expiration	-
rebate_amount	number	Discount amount for early payment	-
discounts	array	List of additional discounts	-
receiver_conciliation_id	string	Payment conciliation identifier by the receiver	35
transaction_data	object	Transaction details related to the initial charge	transaction_data Object

---

additional_data Array

Field	Type	Description	Characters
key_name	string	Additional information name (e.g.: "Interest and Fine")	140
value	string	Value or description of the additional information	140

---

transaction_data Object

Field	Type	Description	Characters
transaction_key	string	Unique transaction key	36
pix_transfer_key	string	Pix transfer identifier	36
end_to_end_id	string	Pix end-to-end identifier	32

---

Enumerators periodicity

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

---

Enumerators journey_type

Enumerator	Description
journey_one	Direct notification in banking app
journey_two	QR Code experience for recurring charge
journey_three	Instant payment + recurring QR Code
journey_four	Recurring opt-in from Pix operation

---

Enumerators settlement_date_type

Enumerator	Description
workdays	Business days
calendar_days	Calendar days

---

Enumerators qr_code_type

Enumerator	Description
dynamic_instant	Dynamic QR Code for instant payment
dynamic_term	Dynamic QR Code for payment with future due date

STATUS

4XX

Response Error

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

HTTP Code	QI Code code	Title title	Description (eng) description	Description (ptbr) translation
400	QIT000002	Bad Request	Invalid request schema.	Erro no esquema da requisição.
404	APX000002	Recurrence Not Found	Recurrence {recurrence_key} not found.	Recorrência {recurrence_key} não encontrada.