跳到主要内容

场景模拟

在 PIX 自动支付框架内模拟创建定期付款和自动付款的分步说明。这些模拟包括创建定期付款和创建预定付款。

1 - 模拟创建定期付款​

请求​

ENDPOINT
/mock/incoming_recurrence
方法
POST
Request Body: 固定金额定期付款
{
  "request_control_key": "01585acf-b0c3-4389-baf3-a58abbe92d58",
  "recurrence_type": "fixed_amount",
  "transaction_amount": 100.50,
  "periodicity": "monthly",
  "journey_type": "journey_one",
  "start_date": "2025-07-01",
  "is_retry_allowed": true,
  "payer_account_information": {
    "owner_name": "John Doe",
    "document_number": "06975239000136",
    "ispb": "32402502",
    "account_digit": "7",
    "account_branch": "3",
    "account_number": "9552432"
}
Request Body: 可变金额定期付款
{
  "request_control_key": "01585acf-b0c3-4389-baf3-a58abbe92d58",
  "recurrence_type": "variable_amount",
  "minimum_transaction_amount": 50.00,
  "periodicity": "monthly",
  "journey_type": "journey_one",
  "start_date": "2025-07-01",
  "is_retry_allowed": true,
  "payer_account_information": {
    "owner_name": "John Doe",
    "document_number": "06975239000136",
    "ispb": "32402502",
    "account_digit": "7",
    "account_branch": "3",
    "account_number": "9552432"}

Request Body 对象​

字段类型描述最大字符数
request_control_key*stringuuid4 格式的请求唯一标识键。36
recurrence_type*string定期付款类型（fixed_amount 或 variable_amount）。20
transaction_amountnumber, null固定金额定期付款（fixed_amount）的交易金额。10
minimum_transaction_amountnumber, null可变金额定期付款（variable_amount）的最低交易金额。10
periodicity*string定期付款的周期。20
journey_type*string授权旅程类型。50
start_date*string定期付款开始日期（YYYY-MM-DD 格式）。10
end_datestring, null定期付款结束日期（YYYY-MM-DD 格式）。10
is_retry_allowed*boolean是否允许交易重试。-
payer_account_information*object付款方账户数据。-
pix_messagestring, null与交易关联的 PIX 消息。140
注意

transaction_amount 或 minimum_transaction_amount 中至少有一个字段必须提供非空值。两个字段不能同时为空。

payer_account_information 对象​

字段类型描述最大字符数
owner_name*string账户持有人姓名。150
document_number*string账户持有人的 CPF 或 CNPJ（仅数字）。14
ispb*string金融机构 ISPB 代码。8
account_digit*string账户校验位。1
account_branch*string账户支行。6
account_number*string账户号码。20
定期付款类型
  • 固定金额定期付款（fixed_amount）：使用 transaction_amount 字段，不发送 minimum_transaction_amount。
  • 可变金额定期付款（variable_amount）：使用 minimum_transaction_amount 字段，不发送 transaction_amount。

响应​

STATUS
200
Response Body
{
    "incoming_recurrence_key": "e13c5986-f4d1-4d07-a56b-eda90862630a",
    "incoming_recurrence_spi_id": "RR32402502202507170197A5B7CB9",
    "incoming_recurrence_status": "pending_confirmation",
    "created_at": "2025-07-17T14:44:38Z",
    "account_key": "ba685cfd-3aee-4992-b6bf-58f8038faa6b"
}

Response Body​

字段类型描述字符数
incoming_recurrence_keyuuid入账定期付款的唯一标识键。36
incoming_recurrence_spi_idstring入账定期付款的 SPI 标识符。29
incoming_recurrence_statusenumerator入账定期付款的当前状态。Enumeradores incoming_recurrence_status
created_atstring定期付款创建的日期和时间（ISO 8601 格式）。-
account_keyuuid账户的唯一标识键。36

Enumeradores incoming_recurrence_status​

枚举值描述
pending_confirmation定期付款待确认
active定期付款已激活
cancelled定期付款已取消
suspended定期付款已暂停
expired定期付款已到期

2 - 模拟创建付款​

请求​

ENDPOINT
/mock/incoming_recurrence/INCOMING_RECURRENCE_SPI_ID/outgoing_payment
方法
POST
Request Body
{
  "transaction_amount": 100.50,
  "target_account_data": {
    "owner_name": "John Doe",
    "owner_document_number": "06975239000136",
    "ispb": "32402502",
    "account_digit": "7",
    "account_branch": "3",
    "account_type": "checking_account",
    "account_number": "9552432"
  },
  "receiver_conciliation_id": "3d7d6a2bf72f44z7bb2079a2b94dff56452",
  "outgoing_payment_spi_id": "7d2d1b6cd72f44z7bb2079a2b94dff52673",
  "end_to_end_id": "E60701190202110191604DY5LHIZ9O66",
  "next_execution_datetime": "2023-06-01"
}

Request Body 对象​

字段类型描述最大字符数
transaction_amount*number交易金额。10
target_account_dataobject目标账户数据。-
receiver_conciliation_id*string接收方对账标识。35
outgoing_payment_spi_id*string付款 SPI 标识符。20
end_to_end_id*stringSPI 中 PIX 交易的幂等键。32
next_execution_datetimestring下次执行的日期和时间（YYYY-MM-DD 格式）。10

target_account_data 对象​

字段类型描述最大字符数
owner_name*string账户持有人姓名。150
owner_document_number*string账户持有人的 CPF 或 CNPJ（仅数字）。14
ispb_number*string金融机构 ISPB 代码。8
account_digit*string账户校验位。1
account_branch*string账户支行。6
account_type*string账户类型。20
account_number*string账户号码。20

Enumerador account_type​

枚举值描述
checking_account支票账户
salary_account工资账户
saving_account储蓄账户
payment_account支付账户

Enumeradores periodicity​

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

Enumeradores journey_type​

枚举值描述
journey_one通过应用内通知申请授权
journey_two通过扫描 QR 码申请授权
journey_three通过扫描 QR 码进行即时 Pix 付款来授权定期付款
journey_four付款或调度 Pix 后依次申请定期付款授权