查询 CPS 信息

开发环境

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

POST

https://developer.toutiao.com/api/apps/trade/v2/query_cps

查询订单CPS信息。可用于判断订单是否为 CPS 订单。返回数据包含订单的支付、CPS、退款、核销等信息。

注意：返回信息只包含 CPS 订单已核销和已退款记录（不包含退款中和退款失败记录）。

请求参数

说明：

order_id 与 out_order_no 二选一。

优先使用 order_id 查询交易模版 1.0 和交易系统的订单信息。

使用 out_order_no 查询担保支付的订单信息（担保支付系统没有交易订单的概念）。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://developer.toutiao.com/api/apps/trade/v2/query_cps' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_id" : "mock_order_id",
    "out_order_no" : "mock_out_order_no"
}'

响应示例

200 - 示例 1

{
    "err_no": 0,
    "err_tips": "string",
    "data": {
        "order_id": "string",
        "out_order_no": "string",
        "payment_info": {
            "pay_time": "string",
            "item_id": "string",
            "total_fee": 0,
            "order_status": "string",
            "pay_channel": 0,
            "channel_pay_id": "string",
            "seller_uid": "string",
            "cp_extra": "string",
            "message": "string"
        },
        "cps_info": {
            "total_commission_amount": 0,
            "cps_item_list": [
                {
                    "commission_amount": 0,
                    "source_type": 0,
                    "item_id": 0,
                    "sell_amount": 0,
                    "status": 0,
                    "item_order_id": "string",
                    "commission_rate": 0,
                    "commission_user_douyinid": "string",
                    "commission_user_nickname": "string"
                }
            ]
        },
        "refund_info": {
            "total_refund_amount": 0,
            "refund_items": [
                {
                    "out_refund_no": "string",
                    "refund_amount": 0,
                    "refund_status": "string",
                    "refund_at": 0,
                    "item_order_id": "string"
                }
            ]
        },
        "delivery_info": {
            "total_delivery_amount": 0,
            "delivery_items": [
                {
                    "delivery_amount": 0,
                    "delivery_status": "string",
                    "delivery_at": 0,
                    "item_order_id": "string"
                }
            ]
        }
    }
}

请求参数

Body 参数application/json

order_id

string

可选

抖音开平内部交易订单号，该单号通过预下单回调传给开发者服务，长度 < 64byte。

out_order_no

string

可选

开发者系统生成的订单号，与唯一 order_id 关联，长度 < 64byte。

示例

返回响应

🟢200成功

application/json

Body

err_no

integer

必需

err_tips

string

必需

data

object

必需

CPS 订单相关信息

order_id

string

抖音开平侧订单号

必需

out_order_no

string

必需

开发者侧订单号，与 order_id一一对应

payment_info

object

必需

CPS 订单支付相关信息

cps_info

object

CPS 相关信息

必需

refund_info

object

必需

CPS 订单已退款记录信息

delivery_info

object

必需

CPS 订单已核销记录信息

🟠400请求有误

修改于 2023-12-01 07:39:03

查询回调地址

查询订单信息

查询 CPS 信息

请求参数#

请求参数

返回响应

请求参数