跳到主要内容

场景模拟

逐步模拟外部代理人所执行操作的生效过程。这些模拟包括：PIX 入账、退款以及 PIX 密钥迁移。

1 - PIX 入账模拟​

Request​

ENDPOINT
/mock/pix_transfer/incoming_pix_transfer
MÉTODO
POST
Request Body
{
  "target_account_key": "\<目标账户唯一密钥\>",
  "amount": "\<交易金额\>"
}

Body 参数​

字段类型描述最大字符数示例备注
target_account_keystring目标账户唯一密钥36"41112f46-0034-4007-85687-5e592173db2"
amountnumber交易金额61000最大值 100,000

Response​

STATUS
201
Response Body
{
  "end_to_end_id": "E60701190202601291553Zrxq8RRUwS1"
}

2 - 模拟 PIX 入账分析结果​

若要模拟 PIX 入账进入人工审核的场景，需要模拟金额超过 R$ 2,000,000.00（两百万）的入账。此情况下，PIX 将处于人工审核状态，客户将收到相应的 Webhook。

注意

两百万的规则仅适用于沙盒环境，不反映生产环境的情况。

收到人工审核 Webhook 后，需使用以下模拟路由对资金入账进行批准或拒绝。客户还将收到包含分析结果的相应 Webhook。

Request​

ENDPOINT
/mock/pix_transfer/incoming_pix_analysis_result
MÉTODO
POST
Request Body
{
  "end_to_end_id": "E60701190202601291537yo1ZxpvVzJn",
  "analysis_status": "manually_reproved"
}

Body 参数​

字段类型描述最大字符数示例备注
end_to_end_idstringPIX 交易唯一密钥32"E60701190202601291537yo1ZxpvVzJn"
analysis_statusenumAnalysis Status 枚举值"manually_reproved"

Analysis Status 枚举值​

枚举值描述
manually_approved人工批准
manually_reproved人工拒绝

3 - 模拟 PIX QR Code 付款​

Request​

ENDPOINT
/mock/pix_transfer/incoming_pix_qrcode
MÉTODO
POST
Request Body
{
  "qr_code_key": "41112f46-0034-4007-85687-5e592173db2"
}

Body 参数​

字段类型描述最大字符数示例备注
qr_code_keystringQR Code 唯一识别密钥36"41112f46-0034-4007-85687-5e592173db2"

4 - 模拟 PIX 退款​

Request​

ENDPOINT
/mock/pix_transfer/chargeback
MÉTODO
POST
Request Body
{
  "end_to_end_id": "\<交易唯一密钥\>",
  "amount": "\<交易金额\>"
}

Body 参数​

字段类型描述最大字符数示例备注
amountnumber交易金额61000最大值 100,000
end_to_end_idstringPIX 交易唯一密钥32"E3240250220210723142712312751267"

5 - 模拟 PIX 密钥迁移 IN Webhook​

Request​

ENDPOINT
/mock/pix_keys/key_claim_request/webhook
MÉTODO
POST
Request Body
{
  "claim_request_key": "\<申请方唯一密钥\>",
  "claim_request_status": "\<状态枚举值\>"
}

Body 参数​

字段类型描述最大字符数示例备注
claim_request_keystring申请方唯一密钥36"ced00dc6-000a-0bd4-a111-85710a46ec05"
claim_request_statusenumClaim Request Status 枚举值"concluded"

Claim Request Status 枚举值​

枚举值描述
concluded已完成
cancelled已取消
failed失败
pending_confirmation待确认

6 - 模拟待确认状态的交易​

当巴西中央银行的 Pix 交易响应出现延迟时，交易可能进入 pending_confirmation 状态。若要模拟此场景，请使用 Pix 密钥 "target_pix_key": "0476f803-0129-430a-a66c-d2f0d7cf4aaa" 发起交易，或对于 manual 类型的 Pix 转账，使用 "owner_document_number": "35586870002" 作为目标账户持有人的文件号。

若要更新交易状态，请使用 sent 作为 transaction_status 批准交易，或使用 rejected 拒绝交易。

Request​

ENDPOINT
/mock/pix_transfer/pending_confirmation
MÉTODO
POST
Request Body
{
  "end_to_end_id": "E32402502202308181802vSHbiqNCk9i",
  "transaction_status": "rejected",
  "status_reason_information": {
    "error_description": "description",
    "error_translation": "translation",
    "error_short_description": "short_description"
  },
  "error_code": "test_error"
}

Body 参数​

字段类型描述最大字符数
end_to_end_id*stringPIX 交易唯一密钥36
transaction_status*enumTransaction Status 枚举值
status_reason_informationobjectStatus Reason Information 对象
error_codestring错误代码

Transaction Status 枚举值​

枚举值描述
sent已完成
rejected已拒绝

Status Reason Information 对象​

字段类型描述最大字符数
error_descriptionstring英文错误描述100
error_translationstring葡语错误描述100
error_short_descriptionstring英文简短错误描述100

7 - 模拟被拒绝的交易​

当巴西中央银行或收款 PSP 预期拒绝 Pix 交易时，交易可能进入 rejected 状态。若要模拟此场景，请使用 Pix 密钥 "target_pix_key": "b9380607-dac6-4e17-8ca7-eb761e3aa1dc" 发起交易，或对于 manual 类型的 Pix 转账，使用 "owner_document_number": "66972913039" 或 "owner_document_number": "50305556000164" 作为目标账户持有人的文件号。

8 - 获取双因素认证发送的 Token​

对于配置了双因素认证的集成商伙伴的个人和批量 Pix 交易，token 将发送给账户变动批准人。通过此端点可获取用于集成测试的 Token。

ENDPOINT
/mock/2fa/transaction_request/TRANSACTION_REQUEST_KEY
MÉTODO
GET

路径参数​

字段类型描述字符数
transaction_request_keyuuid4交易唯一识别密钥。Pix 交易对应 pix_transfer_key，批量 Pix 交易对应 pix_transfer_batch_key36
Response Body
{
  "token": "1a2b3c"
}