API - 退款

提示

当交易发生之后一段时间内，由于用户或者商家的原因需要退款时，商家可以通过退款接口将支付款退还给用户，连连全球收单将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退回用户。

连连全球收单支持单笔交易分多次退款，多次退款需要提交原支付订单的订单号和设置不同的退款请求号。一笔退款失败后重新提交，要保证重试时退款请求号不能变更，防止该笔交易重复退款。同一笔交易累计提交的退款金额不能超过原始交易总金额。

退款成功判断说明：接口返回refund_status = RS为退款成功；refund_status = RP为退款处理中，需要通过退款查询接口进一步确认退款状态，详情可查看退款结果查询。注意，接口中return_code = SUCCESS，仅代表本次退款请求成功，不代表退款成功。

签名构建因子为入参列表中所有参数；
访问时需要将<merchant_id>替换为商户号，<original_transaction_id>为商户支付交易ID；

环境域名地址

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

接口协议结构体

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

请求参数

Header 参数

Body 参数application/json

示例

{
    "merchant_id": "2022010406411679",
    "merchant_refund_time": "20241107154346",
    "merchant_transaction_id": "test2022010408460285106",
    "notification_url": "https://test.merchant.com/v1/test2022010408460285106",
    "original_transaction_id": "2022010408460285106",
    "refund_data": {
        "refund_amount": "13.50",
        "refund_currency_code": "USD"
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

成功示例异常示例

{
    "order": {
        "llTransactionId": "2022010406411679",
        "merchant_transaction_id": "test2022010408460285106",
        "original_transaction_id": "10167419",
        "refund_data": {
            "actual_refund_amount": "1499.00",
            "actual_refund_currency_code": "USD",
            "reason": "do not like the goods",
            "refund_amount": "1499.00",
            "refund_currency_code": "USD",
            "refund_status": "PP",
            "refund_time": "20220104084604",
            "settlement_currency_code": "USD"
        }
    },
    "return_code": "SUCCESS",
    "return_message": "Success",
    "trace_id": "4109.101.16412859638116385"
}