亮色模式

API - 支付取消

GET/v3/merchants/<merchant_id>/payments/<merchant_transaction_id>/cancelpay

:::tip[]
用于交易创建后，用户在一定时间内未进行支付，商家可调用该接口直接将未付款的交易进行关闭。

签名构建因子为 merchant_id，merchant_transaction_id;
访问时需要将替换为商户号，替换为商户支付交易ID；
:::

环境域名地址

生产环境：https://gpapi.lianlianpay.com/v3/merchants/<merchant_id>/payments/<merchant_transaction_id>/cancelpay
沙箱环境：https://celer-api.LianLianpay-inc.com/v3/merchants/<merchant_id>/payments/<merchant_transaction_id>/cancelpay

接口协议结构体

详情可查看请求与响应结构

常见请求示例

https://gpapi.lianlianpay.com/v3/merchants/202103310000001001/payments/20200808000000008/cancelpay

参数名	类型	示例值	说明
merchant_id	string	202103310000001001	商户号
merchant_transaction_id	string	20200808000000008	商户支付交易ID

请求参数

Header 参数

signature

string

签名

必需

示例值:

XJqQTCs1QTsp+xO3iWrEMhMZUF9Wt+s2XTilT48lyv3zCmJS1+twA9cYsq9Bg9hfTnOFziCaU0OD3ddYWTMRf13uyLjwwOKD6LWyBCd+17Fq4bBdFcCwiuA6ZUkXbIWKiLACf8gY0JkKpuEvXSSrvHcpS9MPakuXKKwOBRY1UXBhWr2bL3qr8r4bLUk1A3 5ZU7Oj5r2xZV3JrdeFYqBLss1jbXNT9bS4J5JFoFKw/xBzoBkYh7btm28b8i8Q5lY2Vu7vZVK+BGKfBff2PQOJ347VGyR3+ch4qrw0ABRC52jEycWWoGQbnzs6W8DwBGg64/aR7GpNz9sHIy6YW8KwZg==

timezone

string

时区

必需

示例值:

Asia/Hong_Kong

timestamp

string

必需

格式化时间戳，格式为：yyyyMMddHHmmss

示例值:

20211022160000

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

return_code

string

返回码

必需

返回码

return_message

string

返回消息

必需

返回消息

trace_id

string

追踪号

必需

需要技术支持时候，请提供至LianLian Pay技术人员

order

object (CANCELPAYRESPONSE)

支付数据

必需

提交成功才有返回值

merchantId

string

商户号

必需

<= 64 字符

merchantTransactionId

string

商户支付交易ID

必需

<= 128 字符

allowCancel

boolean

是否取消成功

必需

true：取消成功；
false：取消失败；

message

string

取消失败原因

可选

当 allowCancel = false 时返回

<= 128 字符

cancelTime

number

操作时间戳

必需

{
  "return_code": "SUCCESS",
  "return_message": "Success",
  "trace_id": "15005.100.16413509231380011",
  "order": {
    "merchantId": "202004070000395003",
    "merchantTransactionId": "48",
    "allowCancel": true,
    "message": null,
    "cancelTime": 1641350923148,
    "return_code": null,
    "return_message": null,
    "trace_id": null
  }
}