跳转至

查询退款状态

HTTP请求

GET /v1/payments/charges/refund/{{idempotencyKey}}

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Response
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000007-1",
    "referenceId": "2022030214000007",
    "paymentMethod": "CREDIT_CARD",
    "amount": 300,
    "currency": "MXN",
    "country": "MX",
    "finalAmount": 100,
    "finalCurrency": "MXN",
    "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:58 GMT-08:00",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "document" : "1234567890",
        "phone": "+52 1234567890",
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
        }
    },
    "transferStatus": "SETTLED",
    "description": "refund test",
    "callbackUrl": "https://api.client.com/callback/"
}
HTTP Headers 字段说明
Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}
PATH and Query 字段说明
Parameter Type Description
idempotencyKey String 幂等目的，退款的唯一标识ID
Response Body 字段说明
参数 类型 描述
idempotencyKey String 退款id
referenceId String 支付记录的id
amount Long 退款金额
country String 国家代码，MX
currency String 退款货币代码，MXN
finalAmount Long 用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency String finalAmount的收款货币代码
createTime String 退款请求时间
scheduledTime String 调用时间
finalStatusTime String 退款操作完成时间. 完成包括下面状态： "SETTLED", "FAILED"
transferStatus String 退款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS"
transferStatusCode Integer 此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
transferErrorMsg String 此次交易失败原因

对象字段说明

Payer
参数 必填 类型 描述
name String 名字，全称（入参名字规范：只允许大小写字母，数字和空格的组合。请勿包含西班牙语和葡萄牙语字母，以及其他特殊字符。）
email String 邮箱
document String CURP
phone String 电话号码，需包含“+52”的前缀。
billingAddress JSON 账单邮寄地址
BillingAddress
参数 必填 类型 描述
zipCode String 邮政编码
state String 州
city String 城市
street String 街道
number String 门牌号
回到页面顶部