文档中心 > API类目 > pos交易api

alibaba.pos.pay.cancel (支付撤销接口)

整笔交易单支付成功前可以终止支付,并将已支付金额退款

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
shop_id Number 必须 12 门店ID
pay_cancel_request PayCancelRequest 必须 入参
  • └ request_id
  • String
  • 必须
  • 1
  • 幂等请求Id
  • └ user_id
  • Number
  • 必须
  • 1
  • 用户Id
  • └ payment_order_id
  • String
  • 必须
  • 1
  • 支付单Id
  • └ payer_id
  • Number
  • 必须
  • 1
  • 支付者Id
  • └ orig_paid_request_id
  • String
  • 必须
  • 1
  • 原支付请求Id

响应参数

名称 类型 示例值 描述
result PosResult 1 结果
  • model
  • PayCancelResponse
  • 1
  • 结果对象
  • └ result_status
  • Number
  • 1
  • 结果状态
  • └ result_code
  • String
  • 1
  • 结果码
  • └ result_message
  • String
  • 1
  • 结果信息
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ msg_code
  • String
  • 1
  • msgCode
  • └ msg_info
  • String
  • 1
  • msgInfo
  • └ success
  • Boolean
  • true
  • success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaPosPayCancelRequest req = new AlibabaPosPayCancelRequest();
req.setShopId(12L);
AlibabaPosPayCancelRequest.PayCancelRequest obj1 = new AlibabaPosPayCancelRequest.PayCancelRequest();
obj1.setRequestId("1");
obj1.setUserId(1L);
obj1.setPaymentOrderId("1");
obj1.setPayerId(1L);
obj1.setOrigPaidRequestId("1");
req.setPayCancelRequest(obj1);
AlibabaPosPayCancelResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_pos_pay_cancel_response>
    <result>
        <model>
            <result_status>1</result_status>
            <result_code>1</result_code>
            <result_message>1</result_message>
            <success>true</success>
        </model>
        <msg_code>1</msg_code>
        <msg_info>1</msg_info>
        <success>true</success>
    </result>
</alibaba_pos_pay_cancel_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部