跳转至

退款

该服务可以对已完成的支付发起退款

HTTP请求

POST /v1/payments/charges/refund

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "1ec983fa-1c37-67db-809b-067861c8710020",
    "referenceId": "1ec983fa-1c37-679b-809b-067861c8710010",
    "amount": 1000,
    "currency": "CLP",
    "country": "CL",
    "description": "refund test",
    "callbackUrl": "https://api.client.com/callback/"
}
Response
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "1ec983fa-1c37-67db-809b-067861c8710020",
    "referenceId": "1ec983fa-1c37-679b-809b-067861c8710010",
    "paymentMethod": "MACH",
    "amount": 1000,
    "currency": "CLP",
    "country": "CL",
    "finalAmount": 100,
    "finalCurrency": "CLP",
    "createTime": "2022-03-01 21:18:56 GMT-08:00",
    "scheduledTime": "2022-03-01 21:18:56 GMT-08:00",
    "finalStatusTime": "2022-03-01 21:18:57 GMT-08:00",
     "payer": {
        "name": "Juan Garcia",
        "document": {
            "documentId": "530315550",
            "type": "RUT"
        },
        "email": "juangarcia@example.com"
    },
    "transferStatus": "SETTLED",
    "description": "refund test",
    "callbackUrl": "https://api.client.comcallback/"
}
HTTP Headers 字段说明
健 值
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}
Request Body 字段说明
参数 必填 类型 描述
idempotencyKey String 退款记录在的商家系统的唯一id。
referenceId String 需要退款的支付记录的idempotencyKey。
amount Long 退款金额
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如智利CL
currency String 货币代码，如智利CLP
description String 描述
callbackUrl String 接收交易状态变更通知的地址。接收post请求。
Response Body 字段说明
参数 类型 描述
idempotencyKey String 退款记录在的商家系统的唯一id。
referenceId String 需要退款的支付记录的idempotencyKey。
amount Long 退款金额
paymentMethod String 支付方式
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如智利CL
currency String 货币代码，如智利CLP
description String 描述
callbackUrl String 接收交易状态变更通知的地址。接收post请求。
finalAmount Long 用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency String finalAmount的收款货币代码
createTime String 创建时间
scheduledTime String 执行时间
finalStatusTime String 最终状态更新时间. 最终状态，包括"SETTLED", "FAILED"
description String 退款原因
transferStatus String 退款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS"
transferStatusCode Integer 此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
transferErrorMsg String 此次交易失败原因

对象字段说明

Payer

参数 必填 类型 描述
name String 名字，全称（入参名字规范：只允许大小写字母，数字和空格的组合。请勿包含西班牙语和葡萄牙语字母，以及其他特殊字符。）
email String 邮箱
document JSON 可确认身份的证件，例如智利居民的RUT
phone String 电话号码，需包含“+56”的前缀。

通知 / 回调

Notification / Callback
{
    "eventType": "CHARGE_REFUND_SUCCEEDED",
    "data": {
        "chargeDetails" : {
            "amount" : 1000,
            "callbackUrl" : "https://api.client.com/callback/",
            "country" : "CL",
            "finalAmount": 1000,
            "finalCurrency": "CLP",
            "createTime" : "2022-03-01 15:10:35 GMT+08:00",
            "currency" : "CLP",
            "description" : "refund test",
            "finalStatusTime" : "2022-03-01 15:10:37 GMT+08:00",
            "idempotencyKey" : "1ec983fa-1c37-679b-809b-067861d8700019",
            "payer": {
               "name": "Juan Garcia",
               "document": {
                    "documentId": "530315550",
                    "type": "RUT"
                },
               "email": "juangarcia@example.com"
             },
            "paymentMethod" : "CREDIT_CARD",
            "referenceId" : "1ec983fa-1c37-679b-809b-067861d8700020",
            "scheduledTime" : "2022-03-01 15:10:35 GMT+08:00",
            "transferStatus" : "SETTLED",
            "transferStatusCode" : 200
        }
    }
}
Notification Event Type
CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;
回到页面顶部