跳到主要内容

清算场景模拟

本页面描述如何模拟外部代理执行的操作,以测试票据清算流程。这些模拟对于集成验证和测试非常有用。

信息

这些请求没有响应体(response body)。它们模拟外部操作,仅返回 HTTP 状态码。

1 - 模拟付款通知

模拟票据的付款通知,将票据状态更改为 payment_notice

ENDPOINT
/mock/bank_slip/payment_notice
MÉTODO
POST
Request Body
{
"bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
"paid_amount": 12.0,
"payment_method": "cash",
"payment_type": "full_interbank"
}

Objeto Request Body

字段类型描述最大字符数
bank_slip_key*string票据唯一键36
paid_amountfloat付款金额。若未提供,则使用票据原始金额-
payment_methodstring使用的付款方式-
payment_typestring跨行付款类型-

Enumeradores payment_method

枚举值描述
cash现金
account_debit账户借记
credit_card信用卡
check支票

Enumeradores payment_type

枚举值描述
full_interbank跨行全额支付
partial_interbank跨行部分支付
行为说明
  • 若未提供 paid_amount,将使用票据原始金额
  • 若未提供 payment_type,则视为全额支付(full_interbank
  • 模拟将创建一条付款通知记录
  • 模拟后,票据将移至 payment_notice 状态
  • 重要:对于 partial_interbank,票据状态不会改变。此选项用于模拟部分付款票据的场景,详见简介

2 - 模拟票据清算

模拟票据的付款和财务清算,将票据状态更改为 paid

ENDPOINT
/mock/bank_slip/settlement
MÉTODO
POST
Request Body
{
"bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
"paid_amount": 12.0,
"payment_method": "cash"
}

Objeto Request Body

字段类型描述最大字符数
bank_slip_key*string票据唯一键36
paid_amountfloat清算付款金额。若未提供,则使用票据原始金额-
payment_methodstring使用的付款方式-

Enumeradores payment_method

枚举值描述
cash现金
account_debit账户借记
credit_card信用卡
check支票
行为说明
  • 若未提供 paid_amount,将使用票据原始金额
  • 模拟默认使用代码 65(支付)创建一条付款记录
  • 模拟后,票据将移至 paid 状态