Skip to main content

Query data of a recurrence by outgoing_recurrence_key

Request​

ENDPOINT
/account/ACCOUNT_KEY/outgoing_recurrence/OUTGOING_RECURRENCE_KEY
METHOD
GET

Path Params​

FieldTypeDescriptionCharacters
account_key *uuidv4Unique account identification key.36
outgoing_recurrence_key*uuidv4Unique key of the recurrence to be queried.36

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",
               "time":"14:00"
            },
            "second_retry":{
               "day":"3",
               "time":"12:00"
            },
            "third_retry":{
               "day":"4",
               "time":"15:32"
            }
         }
      },
      "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"
      },
      "payment_orders":[
         {
            "payment_order_key":"10fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_status":"paid",
            "reference_date":"2025-06-30",
            "receiver_conciliation_id":"cac0b5f74ee240f1b2ad16902506503d",
            "transaction_amount":125.53,
            "transaction_key":"21fc62fd-b0a0-4604-9bea-475e91a9dc56",
            "incoming_pix_transfer_key":"21fc62fd-b0a0-4604-9bea-475e91a9dc56",
            "created_at":"2021-10-22T20:30:23.459Z",
            "paid_at":"2023-10-22T20:30:23.459Z"
         }
      ],
      "outgoing_recurrence_events":[
         {
            "outgoing_recurrence_event_key":"20fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "outgoing_recurrence_status":"created",
            "created_at":"2021-10-22T20:30:23.459Z"
         }
      ]
}

Response Body Params​

FieldTypeDescriptionCharacters
request_control_keyuuidv4Unique key for request control.36
outgoing_recurrence_keyuuidv4Identifier of the automatic recurrence.36
outgoing_recurrence_statusstringCurrent status of the recurrence (approved, pending, rejected, etc.).30
periodicityenumeratorRecurrence periodicity.periodicity Enumerators
journey_typeenumeratorAutomatic recurrence journey.journey_type Enumerators
start_datestringRecurrence start date (ISO 8601 format, e.g., 2025-06-10).10
end_datestringRecurrence end date (ISO 8601 format) or null if indefinite.10 or null
outgoing_recurrence_dataobjectObject grouping subscription parameters and additional data.outgoing_recurrence_data Object
payment_ordersarrayObject grouping subscription parameters and additional data.payment_orders Object
outgoing_recurrence_eventsarrayObject grouping recurrence event parametersoutgoing_recurrence_events Object

outgoing_recurrence_data Object​

FieldTypeDescriptionCharacters
minimum_recurrence_amountnumberMinimum expected amount in variable amount recurrences-
recurrence_amountnumberRecurrence amount (for fixed amount; null if variable)-
retry_configurationobjectRetry configuration for incomplete recurrencesretry_configuration Object
debtor_dataobjectDebtor (subscriber) datadebtor_data Object
qr_code_dataobjectQR Code data generated for payment (if any)qr_code_data Object
initial_payment_dataobjectInitial charge datainitial_payment_data Object
pix_messagestringMessage sent along with the PIX transaction140
settlement_date_typeenumeratorSettlement date adjustment typesettlement_date_type Enumerators

retry_configuration Object​

FieldTypeDescriptionCharacters
retry_allowedbooleanIndicates if retries are enabled-
retry_ruleobjectDetailed retry rulesretry_rule Object

retry_rule Object​

FieldTypeDescriptionCharacters
first_retryobjectConfiguration for 1st retryretry_detail Object
second_retryobjectConfiguration for 2nd retryretry_detail Object
third_retryobjectConfiguration for 3rd retryretry_detail Object

retry_detail Object​

FieldTypeDescriptionCharacters
daystringRetry day.-
timestringRetry time.-

debtor_data Object​

FieldTypeDescriptionCharacters
namestringSubscriber name.50
emailstringSubscriber email.100
document_numberstringCPF or CNPJ.14
addressobjectSubscriber address.address Object
account_dataobjectBank account data.account_data Object

address Object​

FieldTypeDescriptionCharacters
citystringCity.-
postal_codestringZIP code.-
ufstringState (abbreviation).-
streetstringStreet address.-

account_data Object​

FieldTypeDescriptionCharacters
account_numberstringAccount number-
account_digitstringAccount digit-
account_branchstringBranch-
ispbstringFinancial institution ISPB-

qr_code_data Object​

FieldTypeDescriptionCharacters
qr_code_keystringGenerated QR Code identifier-
qr_code_urlstringURL for QR Code viewing-
qr_code_imagestringQR Code image (Base64 encoded)-

initial_payment_data Object​

FieldTypeDescriptionCharacters
amountnumberPrincipal amount of the initial charge in reais (R$)-
pix_keystringDestination PIX key for initial payment77
qr_code_typeenumQR Code type for initial charge.qr_code_type Enumerators
additional_dataarrayList of additional information related to the chargeadditional_data Array
fine_amountnumberFine amount in case of late payment-
interest_amountnumberInterest amount in case of late payment-
expiration_datestringInitial charge expiration date (ISO 8601 format)10
max_payment_daysintegerMaximum number of acceptance days after expiration-
rebate_amountnumberDiscount amount for early payment-
discountsarrayList of additional discounts-
receiver_conciliation_idstringPayment conciliation identifier by the receiver35
transaction_dataobjectTransaction details related to the initial chargetransaction_data Object

additional_data Array​

FieldTypeDescriptionCharacters
key_namestringAdditional information name (e.g., "Interest and Fine")140
valuestringAdditional information value or description140

transaction_data Object​

FieldTypeDescriptionCharacters
transaction_keystringUnique transaction key36
pix_transfer_keystringPIX transfer identifier36
end_to_end_idstringPIX end-to-end identifier32

payment_orders Object​

FieldTypeDescriptionCharacters
payment_order_keystringUnique payment order identifier key32
payment_order_statusstringPayment order status-
reference_datestringCharge reference date-
receiver_conciliation_iduuidv4Receiver conciliation ID35
transaction_amountnumberTransaction monetary amount-
transaction_keyuuidv4Unique transaction key36
incoming_pix_transfer_keyuuidv4Received PIX transfer key36
created_atstringOrder creation date/time (ISO 8601 format)-
paid_atstringPayment execution date/time (ISO 8601 format)-

outgoing_recurrence_events Object​

FieldTypeDescriptionCharacters
outgoing_recurrence_event_keystringUnique recurrence event identifier key36
outgoing_recurrence_statusstringRecurrence status-
created_atstringOrder creation date/time (ISO 8601 format)-

periodicity Enumerators​

EnumeratorDescription
weeklyWeekly recurrence
monthlyMonthly recurrence
quarterlyQuarterly recurrence
semiannualSemiannual recurrence
annualAnnual recurrence

journey_type Enumerators​

EnumeratorDescription
journey_oneDirect notification in the banking app
journey_twoQR Code experience for recurring charge
journey_threeInstant payment + QR Code recurrence
journey_fourRecurring opt-in from PIX operation

settlement_date_type Enumerators​

EnumeratorDescription
workdaysWorking days
calendar_daysCalendar days

qr_code_type Enumerators​

EnumeratorDescription
dynamic_instantDynamic QR Code for instant payment
dynamic_termDynamic 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 CodeQI Code
code		Title
title		Description (eng)
description		Description (ptbr)
translation
400QIT000002Bad RequestInvalid request schema.Erro no esquema da requisição.
404APX000002Recurrence Not FoundRecurrence {recurrence_key} not found.Recorrência {recurrence_key} não encontrada.