关闭虚拟账户

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": "1ec983fa-1a37-679b-809b-067861d87ab0",
  "country": "MX",
  "currency": "MXN",
  "createTime": "2023-08-15 20:05:38 GMT-07:00",
  "status": "CANCELLED",
  "description": "this is a test references",
  "callbackUrl": "https://api.client.com/callback/",
  "transferDetails": {
    "clabeAccount": {
      "userInfo": {
        "legalName": "{{TARGET_ACCOUNT_LEGAL_NAME}}",
        "phoneNumber": "{{TARGET_ACCOUNT_PHONE_NUMBER}}"
      },
      "clabeAccountNumber": "706180162569438880"
    }
  }
}

HTTP Headers 字段说明

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

路径参数

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

Response Body 字段说明

参数	类型	描述
transferStatusCode	Integer	此次请求关闭账户的状态码，200表示成功
transferErrorMsg	String	此次关闭账户失败的原因
idempotencyKey	String	此参数用于幂等目的，账号的唯一标识ID，长度不大于128个字节
country	String	国家编码 MX
currency	String	收款货币代码，长度为3个字节，MXN
transferDetails	JSON	交易类型的详细信息
description	String	描述信息
callbackUrl	String	商户接收通知的回调地址. 接收http的post请求
createTime	String	创建时间
status	String	账号状态,如果成功了应该是CANCELLED

TransferDetails 字段说明

参数	类型	描述
clabeAccount	JSON	银行账户的详细信息

ClabeAccount 字段说明

参数	类型	描述
clabeAccountNumber	String	用于支付的clabe账户
userInfo	JSON	用户信息