跳到主要内容

通过 outgoing_recurrence_key 查询定期付款数据

请求​

ENDPOINT
/account/ACCOUNT_KEY/outgoing_recurrence/OUTGOING_RECURRENCE_KEY
方法
GET

Path Params​

字段类型描述字符数
account_key *uuidv4账户的唯一标识键。36
outgoing_recurrence_key *uuidv4待查询的定期付款唯一键。36

响应​

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​

字段类型描述字符数
request_control_keyuuidv4请求控制的唯一键。36
outgoing_recurrence_keyuuidv4自动定期付款标识符。36
outgoing_recurrence_statusstring定期付款的当前状态（approved、pending、rejected 等）。30
periodicityenumerator定期付款的周期。Enumeradores periodicity
journey_typeenumerator自动定期付款的旅程类型。Enumeradores journey_type
start_datestring定期付款开始日期（ISO 8601 格式，如 2025-06-10）。10
end_datestring定期付款结束日期（ISO 8601 格式）或 null（如为无限期）。10 或 null
outgoing_recurrence_dataobject汇集订阅参数和补充数据的对象。Objeto outgoing_recurrence_data
payment_ordersarray汇集付款订单的对象。Objeto payment_orders
outgoing_recurrence_eventsarray汇集定期付款事件参数的对象。Objeto outgoing_recurrence_events

Objeto outgoing_recurrence_data​

字段类型描述字符数
minimum_recurrence_amountnumber可变金额定期付款中的最低预期金额。-
recurrence_amountnumber定期付款金额（固定金额；可变时为 null）。-
retry_configurationobject未完成定期付款的重试配置。Objeto retry_configuration
debtor_dataobject债务人（订阅者）数据。Objeto debtor_data
qr_code_dataobject为付款生成的 QR 码数据（如有）。Objeto qr_code_data
initial_payment_dataobject初始收费数据。Objeto initial_payment_data
pix_messagestring随 Pix 交易一起发送的消息。140
settlement_date_typeenumerator结算日期调整类型。Enumeradores settlement_date_type

Objeto retry_configuration​

字段类型描述字符数
retry_allowedboolean是否启用重试。-
retry_ruleobject重试的详细规则。Objeto retry_rule

Objeto retry_rule​

字段类型描述字符数
first_retryobject第 1 次重试配置。Objeto retry_detail
second_retryobject第 2 次重试配置。Objeto retry_detail
third_retryobject第 3 次重试配置。Objeto retry_detail

Objeto retry_detail​

字段类型描述字符数
daystring重试日期。-
timestring重试时间。-

Objeto debtor_data​

字段类型描述字符数
namestring订阅者姓名。50
emailstring订阅者电子邮件。100
document_numberstringCPF 或 CNPJ。14
addressobject订阅者地址。Objeto address
account_dataobject银行数据。Objeto account_data

Objeto address​

字段类型描述字符数
citystring城市。-
postal_codestring邮政编码。-
ufstring州（缩写）。-
streetstring街道。-

Objeto account_data​

字段类型描述字符数
account_numberstring账户号码。-
account_digitstring账户校验位。-
account_branchstring支行。-
ispbstring金融机构 ISPB。-

Objeto qr_code_data​

字段类型描述字符数
qr_code_keystring生成 QR 码的标识符。-
qr_code_urlstringQR 码查看 URL。-
qr_code_imagestringQR 码图像（Base64）。-

Objeto initial_payment_data​

字段类型描述字符数
amountnumber初始收费的主要金额（巴西雷亚尔 R$）。-
pix_keystring初始付款目标 Pix 键。77
qr_code_typeenum初始收费的 QR 码类型。Enumeradores qr_code_type
additional_dataarray与收费相关的附加信息列表。Array de objects additional_data
fine_amountnumber付款逾期时的罚款金额。-
interest_amountnumber付款逾期时的利息金额。-
expiration_datestring初始收费到期日期（ISO 8601 格式）。10
max_payment_daysinteger到期后的最大受理天数。-
rebate_amountnumber提前付款折扣金额。-
discountsarray附加折扣列表。-
receiver_conciliation_idstring接收方付款对账标识符。35
transaction_dataobject与初始收费相关的交易详情。Objeto transaction_data

Array additional_data​

字段类型描述字符数
key_namestring附加信息名称（如"Juros e Multa"）。140
valuestring附加信息的值或描述。140

Objeto transaction_data​

字段类型描述字符数
transaction_keystring交易唯一键。36
pix_transfer_keystringPix 转账标识符。36
end_to_end_idstringPix 端到端标识符。32

Objeto payment_orders​

字段类型描述字符数
payment_order_keystring付款订单的唯一标识键。32
payment_order_statusstring付款订单状态。-
reference_datestring收费参考日期。-
receiver_conciliation_iduuidv4接收方对账 ID。35
transaction_amountnumber交易的货币金额。-
transaction_keyuuidv4交易唯一键。36
incoming_pix_transfer_keyuuidv4收到的 Pix 转账键。36
created_atstring订单创建日期/时间（ISO 8601 格式）。-
paid_atstring付款日期/时间（ISO 8601 格式）。-

Objeto outgoing_recurrence_events​

字段类型描述字符数
outgoing_recurrence_event_keystring定期付款事件的唯一标识键。36
outgoing_recurrence_statusstring定期付款状态。-
created_atstring订单创建日期/时间（ISO 8601 格式）。-

Enumeradores periodicity​

枚举值描述
weekly每周定期
monthly每月定期
quarterly每季定期
semiannual每半年定期
annual每年定期

Enumeradores journey_type​

枚举值描述
journey_one银行应用内直接通知
journey_two定期收费的 QR 码体验
journey_three即时付款 + QR 码定期付款
journey_fourPix 操作后的定期授权

Enumeradores settlement_date_type​

枚举值描述
workdays工作日
calendar_days日历天数

Enumeradores qr_code_type​

枚举值描述
dynamic_instant即时付款动态 QR 码
dynamic_term未来到期付款动态 QR 码
STATUS
4XX
Response Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "codigo"
}
HTTP 状态码QI 代码
code		标题
title		描述（英文）
description		描述（葡文）
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.