支付宝

取消券核销状态

开发环境

POST

/v3/alipay/marketing/ordervoucher/activity/{activity_id}/voucher/{voucher_code}/refund

alipay.marketing.activity.ordervoucher

商户调用该接口进行优惠券退券处理。接口同步返回结果。
如果优惠券过期后，发起退券操作，该接口返回成功，优惠券退回后仍不可用。
如果优惠券在支付宝卡包已删除，发起退券操作，该接口返回成功，优惠券在支付宝卡包仍然是删除状态。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/marketing/ordervoucher/activity//voucher//refund' \
--header 'Content-Type: application/json' \
--data-raw ''

响应示例

200 - 示例 1

{
  "voucher_use_detail_result_info": {
    "voucher_max_un_use_times": 0
  },
  "activity_id": "2022113000826004726607680740"
}

请求参数

Path 参数

activity_id

string

活动id

必需

voucher_code

string

已核销待退券的券码

必需

Body 参数application/json

voucher_refund_detail_info

object (VoucherRefundDetailInfo)

可选

voucher_refund_use_times

integer

本次取消核销次数

可选

示例值:

merchant_access_mode

string

商户接入模式

可选

示例值:

AGENCY_MODE

out_biz_no

string

可选

外部业务单号，用作幂等控制。幂等作用：参数不变的情况下，再次请求返回与上一次相同的结果。外部接入方需保证业务单号唯一

示例值:

20170101000001654bb46ba

total_fee

string

可选

当前订单的退款总金额(包含优惠券金额)，单位为元。

示例值:

999.99

biz_dt

string

可选

当前订单的退券时间。格式为：yyyy-MM-dd HH:mm:ss

示例值:

{}

示例

返回响应

🟢200common response

application/json

Body

voucher_use_detail_result_info

object (VoucherUseDetailResultInfo)

可选

voucher_max_un_use_times

integer

剩余可核销次数

可选

activity_id

string

优惠券活动id

可选

示例值:

2022113000826004726607680740

🔴500请求失败

修改于 2023-11-22 06:00:10

同步券核销状态

查询商家券活动