跳到主要内容

场景模拟

本页面介绍如何模拟支付工具条目的创建和取消，以测试后付费卡交易流程。这些模拟对于集成联调和测试非常有用。

说明

这些请求模拟外部交易，并返回带有已创建或已取消条目密钥的 HTTP 状态。

1 - 模拟创建支付工具条目​

模拟创建支付工具条目（交易），例如使用后付费卡进行的购买或提款。该条目将根据分期配置自动关联到发票项目。

ENDPOINT
/mock/invoice/payment_instrument/POSTPAID_CARD_KEY/payment_instrument_entry
MÉTODO
POST

路径参数​

字段类型描述字符数
postpaid_card_key *stringUUID v4 格式的后付费卡唯一密钥36
Request Body
{
    "request_control_key": "f7947b9d-9be3-49d8-aca2-4b3249e5fa65",
    "payment_instrument_entry_amount": 100.50,
    "number_of_installments": 3,
    "installment_amount": 33.50,
    "payment_instrument_entry_type": "purchase",
    "payment_instrument_entry_data": {
        "merchant_name": "Test Merchant",
        "merchant_country": "BR",
        "merchant_postal_code": "01310-100",
        "merchant_city": "São Paulo",
        "merchant_street": "Av. Paulista"
    }
}

请求体对象​

字段类型描述最大字符数
request_control_key *uuidv4客户端使用的请求唯一识别密钥36
payment_instrument_entry_amount *float交易总金额-
number_of_installments *integer分期期数-
installment_amount *float每期金额-
payment_instrument_entry_type *string支付工具条目类型payment_instrument_entry_type 枚举值
payment_instrument_entry_data *object交易附加数据payment_instrument_entry_data 对象

payment_instrument_entry_type 枚举值​

枚举值描述
purchase使用卡片进行的购买
withdraw使用卡片进行的提款
postpaid_card_issuance后付费卡发卡

payment_instrument_entry_data 对象​

字段类型描述字符数
merchant_name *string商家名称-
merchant_country *string商家所在国家-
merchant_postal_code *string商家邮政编码-
merchant_city *string商家所在城市-
merchant_street *string商家街道地址-

Response​

STATUS
201
Response Body
{
    "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6"
}

响应体参数​

字段类型描述字符数
payment_instrument_entry_key *uuidv4UUID v4 格式的已创建条目唯一识别密钥36
行为说明
  • 模拟将创建状态为 active 的支付工具条目
  • 该条目将根据所提供的分期数自动关联到发票项目（invoice items）
  • 发票项目将根据钱包的关账配置整理到发票（invoices）中
  • 创建条目前，将验证支付工具和钱包的额度

2 - 模拟取消支付工具条目​

模拟取消现有的支付工具条目，将其状态更改为 canceled 并释放已用额度。

ENDPOINT
/mock/invoice/payment_instrument/POSTPAID_CARD_KEY/payment_instrument_entry/REQUEST_CONTROL_KEY/cancel
MÉTODO
PATCH

路径参数​

字段类型描述字符数
postpaid_card_key *stringUUID v4 格式的后付费卡唯一密钥36
request_control_key *uuidv4创建条目时使用的原始请求唯一识别密钥36
Request Body
{
    "payment_instrument_entry_amount": 100.50
}

请求体对象​

字段类型描述最大字符数
payment_instrument_entry_amount *float取消金额-

Response​

STATUS
200
Response Body
{
    "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6"
}

响应体参数​

字段类型描述字符数
payment_instrument_entry_key *uuidv4UUID v4 格式的已取消条目唯一识别密钥36
行为说明
  • 未关账发票：在未关账发票上取消将立即释放额度并从发票中移除金额
  • 已关账发票：在已关账发票上取消将创建退款，当在下一张发票中使用时，这些退款将显示在 invoice_payments_chargebacks 字段中