cn.felord.payment.wechat.v3.api.direct

Interface InternalPayScoreApi

interface InternalPayScoreApi

支付分API

Since:

2023 /8/21

Author:

dax

Method Summary

Modifier and Type	Method and Description
CancelResponse	cancel(CancelRequest request) 取消支付分订单API
CancelResponse	modify(ModifyRequest request) 修改订单金额API
PayScoreOrderResponse	serviceOrder(PayScoreOrder order) 创建支付分订单API
PayScoreOrder	serviceOrder(QueryServiceOrderParams params) 查询支付分订单API

Method Detail

serviceOrder

@POST(value="v3/payscore/serviceorder")
PayScoreOrderResponse serviceOrder(@Body
                                                                           PayScoreOrder order)
                                                                    throws PayException

创建支付分订单API

Parameters:

order - the order

Returns:

the response body

Throws:

PayException - the pay exception

serviceOrder

@GET(value="v3/payscore/serviceorder")
PayScoreOrder serviceOrder(QueryServiceOrderParams params)
                                                           throws PayException

查询支付分订单API

Parameters:

params - the params

Returns:

the response body

Throws:

PayException - the pay exception

cancel

@POST(value="v3/payscore/serviceorder/{out_order_no}/cancel")
CancelResponse cancel(@Body
                                                                                    CancelRequest request)
                                                                             throws PayException

取消支付分订单API

微信支付分订单创建之后，由于某些原因导致订单不能正常支付时，可使用此接口取消订单。

订单为以下状态时可以取消订单：CREATED（已创单）、DOING（进行中）（包括商户完结支付分订单后，且支付分订单收款状态为待支付USER_PAYING）

注意：

• DOING状态包含了订单用户确认、已完结-待支付（USER_PAYING）的状态，因此这种状态下订单也是可以被取消的，请确认当前操作是否正确，防止误操作将完结后需要支付分收款的单据取消。

特别注意：

1. 待支付（USER_PAYING）状态下，当用户正在尝试通过收银台主动支付订单金额时，取消支付分订单API无法调用成功，可等待3min后重试
2. 重入时需保证参数完全一致，包括撤销原因

Parameters:

request - the request

Returns:

the response body

Throws:

PayException - the pay exception

modify

@POST(value="v3/payscore/serviceorder/{out_order_no}/modify")
CancelResponse modify(@Body
                                                                                    ModifyRequest request)
                                                                             throws PayException

修改订单金额API

完结订单总金额与实际金额不符时，且当服务订单收款状态处于“待支付（USER_PAYING）”时，商户可通过该接口修改订单金额。

注意：

• 若此笔订单已收款成功，商户直接使用退款能力，将差价退回用户即可。
• 修改次数大于等于1，第n次修改后金额小于第n-1次修改后金额。
• 押金订单的金额不支持修改。

特别注意：待支付（USER_PAYING）状态下，当用户正在尝试通过收银台主动支付订单金额时，修改订单金额API无法调用成功，可等待3min后重试

Parameters:

request - the request

Returns:

the cannel response

Throws:

PayException - the pay exception