取消重复支付

重要提示: 此API接口已弃用。

当某个重复支付的支付状态为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": "CO",
    "currency": "COL",
    "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)。需要注意的是除此之外，用户还需根据其支付网点，提交对应的协议号。

协议号对照表¶

线下网点	协议号
Efecty	112766
Refacil	Don't need an agreement code.
Acciones y valores	Don't need an agreement code.
Banco de Bogotá	Don't need an agreement code.
APUESTAS NACIONALES (Corresponsal Banco de Bogotá)	22506
BEMOVIL (Corresponsal Banco de Bogotá)	22506
CB CLARO (Corresponsal Banco de Bogotá)	22506
COMERCIAL CARD (Corresponsal Banco de Bogotá)	22506
CONSUERTE (Corresponsal Banco de Bogotá)	22506
COOPENESA (Corresponsal Banco de Bogotá)	22506
EDEQ (Corresponsal Banco de Bogotá)	22506
FULLCARGA (Corresponsal Banco de Bogotá)	22506
JER (Corresponsal Banco de Bogotá)	22506
MAFEPHONE (Corresponsal Banco de Bogotá)	22506
MAXI SERVICIOS (Corresponsal Banco de Bogotá)	22506
MOVIL RED (Corresponsal Banco de Bogotá)	22506
PEQUEÑAS SUPERFICIES CREDIBANCO (Corresponsal Banco de Bogotá)	22506
PEQUEÑAS SUPERFICIES REDEBAN (Corresponsal Banco de Bogotá)	22506
PRACTISISTEMAS (Corresponsal Banco de Bogotá)	22506
PUNTO DE PAGO (Corresponsal Banco de Bogotá)	22506
PUNTORED (Corresponsal Banco de Bogotá)	22506
SEAPTO (Corresponsal Banco de Bogotá)	22506
SU CHANCE (Corresponsal Banco de Bogotá)	22506
SUPERPAGOS (Corresponsal Banco de Bogotá)	22506