取消未完成的支付

HTTP请求

POST /v1/payments/charges/cancel/{{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": "202209010002",
    "referenceId": "202209010002",
    "paymentMethod": "PAY_CASH",
    "amount": 500,
    "currency": "MXN",
    "country": "MX",
    "finalAmount": 100,
    "finalCurrency": "MXN",
    "createTime": "2022-09-01 01:14:01 UTC",
    "scheduledTime": "2022-09-01 01:14:11 UTC",
    "finalStatusTime":"2022-09-06 00:50:21 UTC",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "billingAddress": {
            "street": "Simón Bolívar",
            "number": "12121",
            "city": "Álamos",
            "state": "CDMX",
            "zipCode": "03400"
        }
    },
    "transferStatus": "CANCELLED",
    "description": "this is a test pay",
    "callbackUrl": "https://api.client.com/callback/",
    "transferDetails": {
        "payCash": {
            "referenceNumber": "1264207400053",
            "expirationDate": "2022-09-30",
            "recurring": false
        }
    },
    "subMerchantId": "UUID"
}

Request Headers 对象字段说明

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

Request 字段说明

参数	必填	类型	描述
idempotencyKey		String	此参数用于幂等目的，交易的唯一标识ID，长度不大于128个字节。

Response Body 字段说明

参数	类型	描述
transferStatus	String	汇款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS"
transferStatusCode	int	此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
transferErrorMsg	String	此次交易失败原因
referenceId	String	此次交易的ID
idempotencyKey	String	此参数用于幂等目的，交易的唯一标识ID，长度不大于128个字节。
amount	Long	收款金额
country	String	国家编码 MX
currency	String	收款货币单位，长度为3个字节，MXN
finalAmount	String	用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency	String	finalAmount的首款货币单位
paymentMethod	String	支付方式. 枚举值, PAY_CASH
payer	JSON	付款人信息
transferDetails	JSON	交易类型的详细信息
description	String	描述信息
callbackUrl	String	商户接收通知的回调地址. 接收http的post请求
createTime	String	创建时间
scheduledTime	String	执行时间
finalStatusTime	String	最终状态更新时间. 最终状态，包括"CANCELLED", "FAILED"
subMerchantId	String	子商户ID。

TransferDetails 对象字段说明

参数	类型	描述
payCash	JSON	PayCash支付的详细信息

PayCash 对象字段说明

参数	类型	描述
referenceNumber	String	支付者支付时使用的reference号码
expirationDate	String	过期时间 墨西哥时间（UTC-5） "yyyy-MM-dd"
recurring	Boolean	是否可以多次付款

支付状态

参数	描述
IN_PROGRESS	交易处理中
SETTLED	交易完成
EXPIRED	交易过期
CANCELLED	交易取消
FAILED	交易失败，异常

Notification 事件类型

CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;