跳转至

创建虚拟账号

HTTP 请求

POST /v1/payments/charges/references

Request Headers
{
  "Content-Type": "application/json",
  "Authorization": "Bearer {{access_token}}",
  "x-api-key": "{{api_key}}"
}
Request Body
{
  "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
  "userInfo": {
    "legalName": "{{TARGET_ACCOUNT_LEGAL_NAME}}",
    "phoneNumber": "{{TARGET_ACCOUNT_PHONE_NUMBER}}"
  },
  "currency": "MXN",
  "country": "MX",
  "paymentMethod": "CLABE_ACCOUNT",
  "callbackUrl": "https://api.client.com/callback/",
  "description": "this is a test references"
}
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": "ACTIVE",
  "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"
    }
  }
}

通知 / 回调

Content-Type: application/json
{
  "eventType": "CHARGE_SUCCEEDED",
  "data": {
    "chargeDetails": {
      "transferStatusCode": 200,
      "transferErrorMsg": null,
      "idempotencyKey": "ref_kbO6Zn4cY4vDfBxwJnztxskL3",
      "referenceId": "1ec983fa-1a37-679b-809b-067861d87ab0",
      "paymentMethod": "CLABE_ACCOUNT",
      "amount": 500,
      "finalAmount": 500,
      "currency": "MXN",
      "country": "MX",
      "finalCurrency": "MXN",
      "createTime": "2022-09-01 01:13:01 UTC",
      "finalStatusTime": "2022-09-01 01:13:01 UTC",
      "payer": {
        "name": "{{TARGET_ACCOUNT_NAME}}",
        "phone": "{{TARGET_ACCOUNT_PHONE}}"
      },
      "transferStatus": "SETTLED",
      "callbackUrl": "https://api.client.com/callback/",
      "transferDetails": {
        "clabeAccount": {
          "beneficiaryAccountNumber": "706180162569438880",
          "referenceNumber": "referenceNumber",
          "trackingId": "trackingId",
          "senderName": "senderName",
          "senderAccountNumber": "senderAccountNumber",
          "paymentTime": "2022-09-01 01:13:01 UTC"
        }
      }
    }
  }
}

HTTP Headers 字段说明

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

Request Body 字段说明

参数 必填 类型 描述
idempotencyKey String 商户系统创建的唯一ID， 长度不大于128个字节
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如墨西哥MX
currency String 货币代码，如墨西哥MXN
paymentMethod String 支付方式. 枚举值如CLABE_ACCOUNT
userInfo JSON 用户信息
description String 描述
callbackUrl String 接收交易状态变更通知的地址。接收post请求。
User Info 对象字段说明
参数 必填 类型 描述
legalName String 名字，全称（入参名字规范：只允许大小写字母，数字和空格的组合。请勿包含西班牙语和葡萄牙语字母，以及其他特殊字符。）
phoneNumber String 电话号码

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 账号状态,枚举值 "ACTIVE"
TransferDetails 字段说明
参数 类型 描述
clabeAccount JSON 银行账户的详细信息
ClabeAccount 字段说明
参数 类型 描述
clabeAccountNumber String 用于支付的clabe账户
userInfo JSON 用户信息

Notification / Callback Body 字段说明

参数 类型 描述
transferStatusCode Integer 此次交易的状态码, 200表示成功
transferErrorMsg String 此次交易失败原因
idempotencyKey String 幂等目的，收款交易的唯一标识ID
referenceId String 账号创建时请求的唯一标识ID
paymentMethod String 支付方式. 枚举值如CLABE_ACCOUNT
amount Long 收款金额，单位是货币最小粒度。 如 100 = 1MXN
finalAmount Long 用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
country String 国家编码 MX
currency String 收款货币代码，长度为3个字节，MXN
finalCurrency String finalAmount的收款货币代码
createTime String 创建时间
finalStatusTime String 最终状态更新时间. 最终状态，包括"SETTLED"
payer JSON 付款人信息
transferStatus String 汇款状态，枚举值，"SETTLED"
callbackUrl String 商户接收通知的回调地址. 接收http的post请求
transferDetails JSON 交易类型的详细信息
ClabeAccount 字段说明
参数 类型 描述
referenceNumber String 支付的参考编号，没有数据时返回空字符串
trackingId String 支付的跟踪键，没有数据时返回空字符串
senderName String 支付人的名字，没有数据时返回空字符串
senderAccountNumber String 支付人的CLABE账号，没有数据时返回空字符串
paymentTime String 虚拟账户实际收款时间，本字段可能因为银行异常，导致没有返回而出现为空字符串的情况
beneficiaryAccountNumber String 收款CLABE账号

Notification 事件类型

CHARGE_SUCCEEDED
回到页面顶部