跳到主要内容

场景模拟

模拟外部代理执行操作的分步说明。这些模拟包括入账交易和退款。

信息

这些请求没有返回负载（响应体）。

1 - 模拟 PIX 入账​

请求​

ENDPOINT
/mock/pix_transfer/incoming_pix_transfer
MÉTODO
POST
请求体
{
  "target_account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "target_alias_key": "c4332971-7cff-42eb-a117-7e6f0cd74db2",
  "amount": 100.01
}

请求体对象​

字段类型描述最大字符数
target_account_key*string目标账户唯一密钥。36
target_alias_keystring目标 Alias 唯一密钥。36
amount*number交易金额。6

2 - 模拟 PIX QR 码付款​

请求​

ENDPOINT
/mock/pix_transfer/incoming_pix_qrcode
MÉTODO
POST
请求体
{
  "target_alias_key": "\<Chave única do alias de destino\>",
  "amount": "\<Valor da transação\>",
  "receiver_conciliation_id": "\<id do receiver conciliation do qr code\>"
}

请求体对象​

字段类型描述最大字符数示例备注
target_alias_key*string目标 Alias 唯一密钥。36"41112f46-0034-4007-85687-5e592173db2"
amount*decimal交易金额。61000.00最大值 100,000
receiver_conciliation_id*stringQR 码接收方对账 ID。361000

3 - 模拟 PIX 退款​

模拟 PIX 出账转账的退款。为此，所有退款的总金额不得超过原始转账的金额。要识别目标交易，请发送原始转账的 end_to_end_id。

请求​

ENDPOINT
/mock/pix_transfer/reversal
MÉTODO
POST
请求体
{
  "end_to_end_id": "E35713491202309182110sSCNh25ooX2",
  "amount": 100.00
}

请求体对象​

字段类型描述最大字符数
end_to_end_id*string待退款交易的唯一密钥。32
amount*number待退款金额。6

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

当巴西中央银行的 PIX 交易响应出现延迟时，PIX 交易可能进入 pending_confirmation 状态。要模拟此场景，请使用 PIX 密钥 "target_pix_key": "0476f803-0129-430a-a66c-d2f0d7cf4aaa" 执行交易；对于 manual 类型的 PIX 转账，请使用目标账户所有者文档号 "owner_document_number": "35586870002"。

要更新交易状态，请使用 transaction_status 为 sent（批准交易）或 rejected（拒绝交易）执行以下请求。

请求​

ENDPOINT
/mock/pix_transfer/pending_confirmation
MÉTODO
POST
请求体
{
  "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"
}

请求体参数​

字段类型描述最大字符数
end_to_end_id*stringPIX 交易唯一密钥。36
transaction_status*enum交易状态枚举值
status_reason_informationobjeto状态原因信息对象
error_codestring错误代码。

交易状态枚举值​

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

状态原因信息对象​

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

5 - 模拟已拒绝交易​

当巴西中央银行或收款 PSP 返回预期的拒绝响应时，PIX 交易可能进入 rejected 状态。要模拟此场景，请使用 PIX 密钥 "target_pix_key": "b9380607-dac6-4e17-8ca7-eb761e3aa1dc" 执行交易；对于 manual 类型的 PIX 转账，请使用目标账户所有者文档号 "owner_document_number": "66972913039" 或 "owner_document_number": "50305556000164"。