Skip to main content

Consulta de Dados de Recorrência Automática Pix por ourtgoing_recurrence_key

Request​

ENDPOINT
/automatic_pix/account/ACCOUNT_KEY/outgoing_recurrence/OUTGOING_RECURRENCE_KEY
MÉTODO
GET

Path Params​

CampoTipoDescriçãoCaracteres
account_key *uuidv4Chave única de identificação da conta.36
outgoing_recurrence_key*uuidv4Chave única da recorrência a ser consultada.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":"uuid",
         "transaction_data":{
            "transaction_key":"uuid",
            "pix_transfer_key":"uuid",
            "end_to_end_id":"end_to_end"
         }
      },
      "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":"cac0b5f7-4ee2-40f1-b2ad-16902506503d",
            "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"
         }
      ]
   }
}

Response Body Params​

CampoTipoDescriçãoCaracteres
request_control_keyuuidv4Chave única para controle da requisição.36
outgoing_recurrence_keyuuidv4Identificador da recorrência automática.36
outgoing_recurrence_statusstringStatus atual da recorrência (approved, pending, rejected, etc.).30
periodicityenumeratorPeriodicidade da recorrência.Enumeradores periodicity
journey_typeenumeratorJornada da recorrência automática.Enumeradores journey_type
start_datestringData de início da recorrência (formato ISO 8601, e.g., 2025-06-10).10
end_datestringData de término da recorrência (formato ISO 8601) ou null, se indeterminado.10 ou null
outgoing_recurrence_dataobjectObjeto agrupando parâmetros da assinatura e dados complementares.Objeto outgoing_recurrence_data
payment_ordersarrayObjeto agrupando parâmetros da assinatura e dados complementares.Objeto payment_orders

Objeto outgoing_recurrence_data​

| Campo | Tipo | Descrição | Caracteres |n |-----------------------------|---------|---------------------------------------------------------|---------------------------------| | payment_order_key | string | Chave única identificadora da ordem de pagamento | 32 | | payment_order_status | string | Status da ordem de pagamento | - | | reference_date | string | Data de referência da cobrança | - | | receiver_conciliation_id | uuidv4 | ID de conciliação do recebedor | 36 | | transaction_amount | number | Valor monetário da transação | - | | transaction_key | uuidv4 | Chave única da transação | 36 | | incoming_pix_transfer_key | uuidv4 | Chave de transferência Pix recebida | 36 | | created_at | string | Data/hora de criação da ordem (formato ISO 8601) | - | | paid_at | string | Data/hora do pagamento efetuado (formato ISO 8601) | - |​

Objeto outgoing_recurrence_data​

CampoTipoDescriçãoCaracteres
minimum_recurrence_amountnumberValor mínimo esperado nas recorrências de valor variável-
recurrence_amountnumberValor da recorrência (para valor fixo; null se variável)-
retry_configurationobjectConfiguração de tentativas para recorrências não concluídasObjeto retry_configuration
debtor_dataobjectDados do devedor (assinante)Objeto debtor_data
qr_code_dataobjectDados de QR Code gerado para o pagamento (se houver)Objeto qr_code_data
initial_payment_dataobjectDados da cobrança inicialObjeto initial_payment_data
pix_messagestringMensagem enviada junto à transação Pix140
settlement_date_typeenumeratorTipo do ajuste da data de liquidaçãoEnumeradores settlement_date_type

Objeto retry_configuration​

CampoTipoDescriçãoCaracteres
retry_allowedbooleanIndica se retentativas estão habilitadas-
retry_ruleobjectRegras detalhadas das retentativasObjeto retry_rule

Objeto retry_rule​

CampoTipoDescriçãoCaracteres
first_retryobjectConfiguração para 1ª retentativaObjeto retry_detail
second_retryobjectConfiguração para 2ª retentativaObjeto retry_detail
third_retryobjectConfiguração para 3ª retentativaObjeto retry_detail

Objeto retry_detail​

CampoTipoDescriçãoCaracteres
daystringDia da retentativa.-
timestringHorário da retentativa.-

Objeto debtor_data​

CampoTipoDescriçãoCaracteres
namestringNome do assinante.50
emailstringE-mail do assinante.100
document_numberstringCPF ou CNPJ.14
addressobjectEndereço do assinante.Objeto address
account_dataobjectDados bancários.Objeto account_data

Objeto address​

CampoTipoDescriçãoCaracteres
citystringCidade.-
postal_codestringCEP.-
ufstringEstado (sigla).-
streetstringLogradouro.-

Objeto account_data​

CampoTipoDescriçãoCaracteres
account_numberstringNúmero da conta-
account_digitstringDígito da conta-
account_branchstringAgência-
ispbstringISPB da instituição financeira-

Objeto qr_code_data​

CampoTipoDescriçãoCaracteres
qr_code_keystringIdentificador do QR Code gerado-
qr_code_urlstringURL para visualização do QR Code-
qr_code_imagestringImagem do QR Code (em Base64)-

Objeto initial_payment_data​

CampoTipoDescriçãoCaracteres
amountnumberValor principal da cobrança inicial em reais (R$)-
pix_keystringChave Pix de destino para o pagamento inicial77
qr_code_typeenumTipo de QR Code para cobrança inicial.Enumeradores qr_code_type
additional_dataarrayLista de informações adicionais relacionadas à cobrançaArray de objects additional_data
fine_amountnumberValor da multa, caso ocorra atraso no pagamento-
interest_amountnumberValor dos juros, caso ocorra atraso no pagamento-
expiration_datestringData de expiração da cobrança inicial (formato ISO 8601)10
max_payment_daysintegerNúmero máximo de dias de aceite após expiração-
rebate_amountnumberValor do desconto para pagamento antecipado-
discountsarrayLista de descontos adicionais-
receiver_conciliation_idstringIdentificador de conciliação do pagamento pelo recebedor36
transaction_dataobjectDetalhes da transação relacionada à cobrança inicialObjeto transaction_data

Array additional_data​

CampoTipoDescriçãoCaracteres
key_namestringNome da informação adicional (ex: "Juros e Multa")140
valuestringValor ou descrição da informação adicional140

Objeto transaction_data​

CampoTipoDescriçãoCaracteres
transaction_keystringChave única da transação36
pix_transfer_keystringIdentificador da transferência Pix36
end_to_end_idstringIdentificador end-to-end do Pix32

Enumeradores periodicity​

EnumeradorDescrição
weeklyRecorrência semanal
monthlyRecorrência mensal
quarterlyRecorrência trimestral
semiannualRecorrência semestral
annualRecorrência anual

Enumeradores journey_type​

EnumeradorDescrição
journey_oneNotificação direta no aplicativo bancário
journey_twoExperiência QR Code para cobrança recorrente
journey_threePagamento instantâneo + recorrência QR Code
journey_fourOpt-in recorrente a partir de operação Pix

Enumeradores settlement_date_type​

EnumeradorDescrição
workdaysDias úteis
calendar_daysDias corridos

Enumeradores qr_code_type​

EnumeradorDescrição
dynamic_instantQR Code dinâmico para pagamento instantâneo
dynamic_termQR Code dinâmico para pagamento com vencimento futuro
STATUS
4XX
Response Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "codigo"
}
Código HTTPCódigo QI
code		Título
title		Descrição (eng)
description		Descrição (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.