取消/更新 Order 对象

你可以对待支付状态的 order 对象进行取消动作,已经支付、过期订单不能取消,订单被取消后不能再次发起支付。 订单未调用 pay 接口之前,可以进行订单信息修改,statususer 用于取消订单,其余参数用于更新订单信息;。分润方式不支持改变,原来是模版,只能更新模版不能换成按用户列表分润,反之亦然。 订单在到达过期时间时仍未完成付款,Ping++ 会自动改变订单状态为已取消。订单如果使用优惠券,在取消后,会自动退回优惠券。

请求参数描述
ORDER_ID required stringPing++ 返回的 order 对象的 id,用于商品订单查询、退款,该参数仅需要填写在请求地址内。
status required string值填 canceled,表示更新 order 对象的状态。
user optional stringuser 对象的 id,传入该参数以检查是否和订单的 user 值一致,默认不检查。
amount conditional integer1~1000000000,订单总金额,单位:分。
subject conditional string商品标题,该参数最长为 32 个 Unicode 字符。银联全渠道限制在 32 个字节;支付宝部分渠道不支持特殊字符;cmpay 渠道限制为 1~25 个 Unicode 字符;isv_lite 渠道限制为:1~20 个 unicode 长度,不允许以下特殊字符串"\n\r,,~!@#¥%……&*()【】「」"
body conditional string商品描述信息,该参数最长为 128 个 Unicode 字符。yeepay_wap 对于该参数长度限制为 100 个 Unicode 字符;支付宝部分渠道不支持特殊字符。
description conditional string附加说明,最多 255 个 Unicode 字符。
time_expire conditional integer订单过期时间,修改后的时间范围暂不支持超过原来的最大值,也不支持改为当前时刻之前。
metadata conditional hash详见 元数据
receipt_app conditional string收款方 app 对象的 id,默认为订单应用。订单使用收款方应用的渠道参数进行支付。
service_app conditional string服务方 app 对象的 id,默认为订单应用。表示承接该交易服务的应用,由服务方和平台确定订单的层级链都能查询到该 order 对象。
royalty_users conditional list分润的用户信息列表,默认为[],不分润。详见下方的 royalty_users 字段说明
royalty_template conditional stringroyalty_template 对象的 id。该参数与 royalty_users 同时传时将会被忽略。
balance_settlement conditional hash余额结算信息。订单支付完成时,将扣除用户手续费后的支付金额结算到指定的用户余额账户。仅对开通了 balance 渠道的应用有效。详见下方的 balance_settlement 字段说明
royalty_users 字段说明描述
user required string分润的 user 对象 id
amount required int分润的金额,单位为分。
balance_settlement 字段说明描述
user required string结算的 user 对象的 id
user_fee optional int结算时收取的用户手续费,由被结算用户承担,单位分,默认值为 0。

返回

返回一个 order 对象,或者返回一个错误,详见 错误

定义

PUT https://api.pingxx.com/v1/orders/{ORDER_ID}
待补充
待补充
待补充
待补充
待补充
待补充
待补充

请求示例

curl https://api.pingxx.com/v1/orders/2001608270000004428 \
-H "Pingplusplus-Request-Timestamp: 1475029155" \
-H "Pingplusplus-Signature: SIGNATURE" \
-u sk_test_ibbTe5jLGCi5rzfH4OqPW9KC:
-d '
	{
	"status": "canceled",
  	"user": "user_007"
  	}'
待补充
待补充
待补充
待补充
待补充
待补充
待补充

返回示例

{
    "id": "2001708140000017551",
    "object": "order",
    "created": 1502695388,
    "livemode": false,
    "paid": false,
    "refunded": false,
    "status": "canceled",
    "app": "app_1Gqj58ynP0mHeX1q",
    "uid": "user_007",
    "available_balance": 0,
    "merchant_order_no": "2017081400000006",
    "amount": 1000,
    "actual_amount": 800,
    "amount_refunded": 0,
    "amount_paid": 0,
    "coupon_amount": 200,
    "currency": "cny",
    "subject": "Your Subject",
    "body": "Your Body",
    "client_ip": "127.0.0.1",
    "time_paid": null,
    "time_expire": 1502781019,
    "coupon": "300317081415225500002001",
    "description": "",
    "metadata": {},
    "charge_essentials": {},
    "receipt_app": "app_1Gqj58ynP0mHeX1q",
    "service_app": "app_1Gqj58ynP0mHeX1q",
    "available_methods": [],
    "charges": {
        "object": "list",
        "url": "/v1/charges",
        "has_more": false,
        "data": [
            {
                "id": "ch_1Kyn50DyjXbHbvnv5SGK4qDK",
                "object": "charge",
                "created": 1502695440,
                "livemode": false,
                "paid": false,
                "refunded": false,
                "reversed": false,
                "app": "app_1Gqj58ynP0mHeX1q",
                "channel": "alipay_qr",
                "order_no": "2017081400000006",
                "client_ip": "127.0.0.1",
                "amount": 800,
                "amount_settle": 800,
                "currency": "cny",
                "subject": "Your Subject",
                "body": "Your Body",
                "extra": {},
                "time_paid": null,
                "time_expire": 1502781019,
                "time_settle": null,
                "transaction_no": null,
                "refunds": null,
                "amount_refunded": 0,
                "failure_code": null,
                "failure_msg": null,
                "metadata": {},
                "credential": {},
                "description": null
            }
        ]
    }
}