统一收单交易结算接口

开发环境

http://dev-cn.your-api-server.com

POST

/v3/alipay/trade/order/settle

alipay.trade.order

用于在卖家交易成功之后，基于交易订单，进行卖家与第三方（如供应商或平台商）的资金再分配。一般用于第三方从卖家抽佣场景。

注意:

\1. 订单确认结算后，才可发起分账。
\2. 同一笔订单，同步分账和异步分账不能混用。如果业务上存在一次分账请求超过5个分账收款方的情况，推荐使用异步分账。
\3. 建议支付成功后间隔 30s 再发起该接口请求
\4. 单个卖家请求频率最高 30 TPS。接口报错FREQUENCY_LIMIT 请控制请求频率
\5. 如果接口调用超时或者返回ACQ.SYSTEM_ERROR ACQ.TRADE_SETTLE_ERROR 当前请求可能成功也可能失败。请使用相同的参数再次重试调用，外部请求号和金额等均不能变更。如果前一次分账已经成功，接口会幂等返回成功；如果前一次分账请求没有成功，接口会重试执行分账操作

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/trade/order/settle' \
--header 'Content-Type: application/json' \
--data-raw '{
    "extend_params": {
        "royalty_finish": "true"
    },
    "operator_id": "A0001",
    "out_request_no": "20160727001",
    "royalty_mode": "async",
    "royalty_parameters": [
        {
            "amount": "string",
            "amount_percentage": 0,
            "desc": "string",
            "royalty_scene": "string",
            "royalty_type": "string",
            "trans_in": "string",
            "trans_in_name": "string",
            "trans_in_type": "string",
            "trans_out": "string",
            "trans_out_type": "string"
        }
    ],
    "trade_no": "2014030411001007850000672009"
}'

响应示例

200 - 成功示例

{
    "trade_no": "2015070921001004130000127422",
    "settle_no": "20210718002530070036530006474222"
}

请求参数

Body 参数application/json

extend_params

object (SettleExtendParams)

可选

royalty_finish

string

可选

冻结分账场景下生效，其他场景传入无效。代表该交易分账是否完结，可选值：true/false，不传默认为false。 true：代表分账完结，则本次分账处理完成后会把该笔交易的剩余冻结金额全额解冻。 false：代表分账未完结。

示例值:

true

operator_id

string

可选

操作员 ID，商家自定义操作员编号。

示例值:

A0001

out_request_no

string

可选

结算请求流水号，由商家自定义。32个字符以内，仅可包含字母、数字、下划线。需保证在商户端不重复。

示例值:

20160727001

royalty_mode

string

可选

分账模式，目前有两种分账同步执行sync，分账异步执行async，不传默认同步执行

示例值:

async

royalty_parameters

array[object (OpenApiRoyaltyDetailInfoPojo) {10}]

可选

分账明细信息。单独调用分账完结时，可以不传此参数。其他场景必传。注意：商家分账场景下分账收入方 trans_in 只支持支付宝账户，不支持使用 cardAliasNo 卡编号。

amount

string

可选

分账的金额，单位为元

amount_percentage

integer

可选

分账信息中分账百分比。取值范围为大于0，少于或等于100的整数。

desc

string

分账描述

可选

royalty_scene

string

可选

可选值：达人佣金、平台服务费、技术服务费、其他

royalty_type

string

分账类型.

可选

trans_in

string

可选

收入方账户。如果收入方账户类型为userId，本参数为收入方的支付宝账号对应的支付宝唯一用户号，以2088开头的纯16位数字；如果收入方类型为cardAliasNo，本参数为收入方在支付宝绑定的卡编号；如果收入方类型为loginName，本参数为收入方的支付宝登录号；

trans_in_name

string

可选

分账收款方姓名，上送则进行姓名与支付宝账号的一致性校验，校验不一致则分账失败。不上送则不进行姓名校验

trans_in_type

string

收入方账户类型。

可选

trans_out

string

可选

支出方账户。如果支出方账户类型为userId，本参数为支出方的支付宝账号对应的支付宝唯一用户号，以2088开头的纯16位数字；如果支出方类型为loginName，本参数为支出方的支付宝登录号。泛金融类商户分账时，该字段不要上送。

trans_out_type

string

支出方账户类型。

可选

trade_no

string

支付宝订单号

可选

示例值:

2014030411001007850000672009

示例

返回响应

🟢200common response

application/json

Body

settle_no

string

可选

支付宝分账单号，可以根据该单号查询单次分账请求执行结果

示例值:

20210718002530070036530006474222

trade_no

string

支付宝交易号

可选

示例值:

2015070921001004130000127422

🔴500请求失败

修改于 2023-11-21 02:51:02

分账关系查询

交易分账查询接口