API Reference
API Reference

退款

事件列表

事件名称事件类型触发时机通知数据结构
退款成功v2.refunds.succeeded退款成功时Refund
退款失败v2.refunds.failed退款失败时Refund

事件对象

属性类型描述
access_nostring分配的接入方编号
merchant_idstring接入方的商户号
refund_idstring退款单 ID
trade_idstring交易单 ID
currencystring金额对应的交易币种
reasonstring退款原因
refund_amountstring退款金额
refund_statusstring退款状态
  • pending: 处理中
  • failed:退款失败
  • succeeded: 退款成功
metadatamap<string, string>透传的元数据,key 长度不超过 40 字节,value 长度不超过 500 字节,JSON编码后 ≤ 1024字节
failure_reasonstring失败原因
ref_arnstring发卡行侧返回退款凭证
finished_atstring退款完成时间

示例数据

{
    "id": "572683623191290916",
    "type": "v2.refunds.succeeded",
    "created": "2025-10-28T07:20:15Z",
    "data": {
        "reason": "",
        "access_no": "77d52a21dc032b4",
        "merchant_id": "2816433",
        "refund_id": "20251028572683602265931714",
        "currency": "USD",
        "failure_reason": null,
        "ref_arn": "",
        "finished_at": "2025-10-28T07:20:15Z",
        "trade_id": "572679783406649282",
        "refund_amount": "15.57",
        "refund_status": "succeeded",
        "metadata": null
    }
}
{
    "id": "550627286320154211",
    "type": "v2.refunds.failed",
    "created": "2025-08-28T10:36:15Z",
    "data": {
        "access_no": "78f3c0d56803a11",
        "merchant_id": "2816411",
        "currency": "USD",
        "metadata": null,
        "failure_reason": {
            "code": "100999",
            "message": "insufficient account balance"
        },
        "ref_arn": "",
        "refund_id": "20250828550582487160487110",
        "trade_id": "549527688117761146",
        "reason": "",
        "refund_amount": "39.00",
        "refund_status": "failed",
        "finished_at": null
    }
}
These developer docs retire on 2026-08-30. Visit the new docs: NEW DOCS本开发者文档将于 2026-08-30下线,请访问新版文档: 新文档