跳转至

查询退款状态

HTTP请求

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

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Content-Type: application/json
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "2022030214000007-1",
    "referenceId": "2022030214000007",
    "paymentMethod": "CARD",
    "amount": 300,
    "currency": "UYU",
    "country": "UY",
    "finalAmount": 100,
    "finalCurrency": "UYU",
    "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": {
        "document":{
            "documentId":"41234567",
            "type":"CI"
        },
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+59881987654321",
        "billingAddress": {  
            "zipCode": "1001",
            "state": "Buenos Aires",
            "city": "Buenos Aires",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "5940",
            "complement": "casa",
            "country": "UY"
        }
    },
    "transferStatus": "SETTLED",
    "description": "refund test",
    "callbackUrl": "https://api.client.comcallback/"
}

HTTP Headers 参数说明

Key Value
Authorization "Bearer" + " " + {{access_token}}
x-api-key {{api_key}}

路径参数

参数 类型 描述
idempotencyKey String 幂等目的，退款的唯一标识ID

Response Body 字段说明

参数 类型 描述
idempotencyKey String 退款记录在的商家系统的唯一id。
referenceId String 需要退款的支付记录的idempotencyKey。
amount Long 退款金额
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准
currency String 货币代码
finalAmount Long 用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency String finalAmount的收款货币代码
description String 描述
callbackUrl String 接收交易状态变更通知的地址。接收post请求。
createTime String 创建时间
scheduledTime String 执行时间
finalStatusTime String 最终状态更新时间. 最终状态，包括"SETTLED", "FAILED"
description String 退款原因
transferStatus String 退款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS"
transferStatusCode Integer 此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
transferErrorMsg String 此次交易失败原因
回到页面顶部