取消重复支付

当某个重复支付的支付状态为ACTIVE时，可以将其取消。

HTTP 请求

POST /v1/payments/charges/references/cancel/{{idempotencyKey}}

请求响应

Request Headers

{
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}

Content-Type: application/json

{
    "transferStatusCode": 200,
    "idempotencyKey": "{{idempotencyKey}}",
    "country": "MX",
    "currency": "MXN",
    "createTime": "2023-10-20 02:40:07 UTC",
    "status": "CANCELLED",
    "description": "",
    "transferDetails": {
        "payCash": {
            "amount": 0,
            "expirationDate": "2024-09-30",
            "reference": "1264248200066"
        }
    }
}

HTTP Headers 字段说明

Key	Value
Authorization	"bearer"+ "" + {{access_token}}

路径参数

参数	类型	描述
idempotencyKey	String	商户系统创建的唯一ID。

Response Body 字段说明

参数	类型	描述
transferStatusCode	Integer	此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
idempotencyKey	String	此参数用于幂等目的，交易的唯一标识ID
country	String	国家编码
currency	String	收款货币代码
createTime	String	创建时间
status	String	交易状态，如果成功了应该是CANCELLED
description	String	描述信息
transferDetails	JSON	交易类型的详细信息

对象字段说明

TransferDetails

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

PayCash

参数	类型	描述
amount	Long	交易金额
expirationDate	String	过期日期 当地时间 "yyyy-MM-dd"
reference	String	这是一个可以被多次重复使用的交易号。支付者在支付时，需要提供的交易号(reference number/referencia)。需要注意的是除此之外，用户还需根据其支付网点，提交对应的协议号。

协议号对照表

线下网点	协议号
7-ELEVEN	Don't need an agreement code.
Kiosko	Don't need an agreement code.
Farmacias YZA	Don't need an agreement code.
BBVA (PRACTICAJA - BANCA DIGITAL)	1420712
Caja Cerano	Don't need an agreement code.
Caja Morelia Valladolid	Don't need an agreement code.
Caja Oblatos	Don't need an agreement code.
SMB Rural	Don't need an agreement code.
CALIMAX	Don't need an agreement code.
Circulo K	Don't need an agreement code.
Tiendas Extra	Don't need an agreement code.
CITY CLUB	Don't need an agreement code.
FARMACIA LA MAS BARATA	Don't need an agreement code.
FARMACIAS ROMA	Don't need an agreement code.
HSBC	7755
Santander (VENTANILLA - SUPERNET)	7292
SORIANA	Don't need an agreement code.
SUPER CITY	Don't need an agreement code.
SUPER DEL NORTE	Don't need an agreement code.
Telecomm	3724
Bodega Aurrera	198
Walmart	198
Sam's Club	198
Walmart express	198
Via servicios	Don't need an agreement code.
BANORTE (VENTANILLA -BANCA DIGITAL)	3724
AFIRME (BANCA DIGITAL)	Don't need an agreement code.