易汇卡api

## 1.引言
本部分对TransferEasy易汇卡相关接口进行详细地描述，通过该文档可以对本接口有个全面的了解，使商户技术人员尽快掌握本接口，并能够在此基础上进行开发。

### 1.1概述
本部分详细介绍了TransferEasy易汇卡相关接口进行了详细描述。接口采用https+token的方式来保证商户与交易平台间的身份验证、中间信息传递的完整性，以便进行电子商务安全当中非常重要的交易身份辨识、不可抵赖、防止篡改等功能。

### 1.2使用对象
TransferEasy商户的网上应用开发人员、维护人员和管理人员，他们应具备以下基本知识:

1. 了解上述系统上的网站设置和网页制作方法;
2. 了解HTML语言或了解JAVA、PHP、.NET 等开发语言;
3. 了解信息安全的基本概念。

### 1.3需求栏

| 标记 | 含义   |
|----|------|
| M  | 必填   |
| C  | 有条件的 |
| O  | 可选   |

#### 1.4接入规范
TransferEasy所有的数据提交和接收的方式皆是以post方式提交和接收，我们的异步回调是以流的方式返回。

| 环境 | 地址 |
| --- | --- |
|  测试|https://test-merchant-api.transfereasy.com/  |
| 生产 | https://java-merchant-web-api.transfereasy.com |

#### 1)同步请求
HTTP头必须包括Authorization: Bearer [token]。访问令牌有效期为30分钟，可以多次用于所有其他API端点，直到过期。
同步接口的请求和响应header中都包含以下参数：

| header参数     | 说明     | 生成方法                         |
|--------------|--------|------------------------------|
| ContentType | 内容编码类型 | 固定值：application/json         |
| MerchantNO   | 商户号    | 由Transfereasy统一生成分配          |
| Timestamp    | 时间戳    | 即生成待签名字符串时的Timestamp         |
| Signature    | API签名  | 即生成签名中得到的结果                  |
| RequestId   | 请求流水号    | 每个请求唯一         |

#### 2)数字签名

- i.若无特殊说明，Transfereasy notify需验签，以便商户确认Transfereasy身份

- iv.生成待签名字符串
- - a.将请求参数（GET请求的query string，POST请求的form内容）按照参数名ASCII码从小到大排序（字典序）后，使用URL键值对的格式（即key1=value1&key2=value2…）拼接成参数字符串，注意：键值中的value需要进行URL编码。

- - b.在参数字符串后面拼接上Timestamp，用,隔开,得到待签名字符串。

- v.生成签名

- - a.将待签名字符串用RSA加密，哈希算法采用SHA256，密钥使用申请服务时提交的密钥对的私钥。
- - b.将加密结果使用base64进行编码，得到最终的签名结果。
- vi.添加请求头

异步通知的请求包含以下参数：

| header参数     | 说明     | 生成方法                         |
|--------------|--------|------------------------------|
| Content-Type | 内容编码类型 | 固定值：application/json         |
| MerchantNO   | 商户号    | 由Transfereasy统一生成分配          |
| ProductCode  | 产品号    | 由Transfereasy开通权限的产品号，详见产品编号 |
| Timestamp    | 时间戳    | 即生成待签名字符串时的Timestamp         |
| Signature    | API签名  | 即生成签名中得到的结果                  |

a.将收到的回调通知POST请求的form内容按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成签名字符串，注意：需要对键值中的value值进行URL编码。

b.在签名字符串后面拼接上POST请求header中的Timestamp值，用,隔开，得到query_string。

c.将query_string以及POST请求header中的Signature值，先进行base64解码后，再使用SHA-256验签。

应答机制（订单异步返回）是指当贵公司系统收到TransferEasy的支付成功或者取消数据通知（服务器点对点通讯形式）时，必须输出“success”TransferEasy收到 “success”，便认为贵公司已收到；否则将继续发送通知，以递增的时间间隔再次重发 9 次；时间间隔分别为 1s/5s/10s/30s/1m/2m/3m/4m/5m，以确保订单通知成功。(特别提醒：同样的通知可能会多次发送给商户、商户侧系统必须能够正确处理重复的通知，即做幂等处理。 推荐的做法是，当商户侧系统收到通知进行处理时，先检查对应业务数据的状态，并判断该通知是否已经处理，如果未处理，则进行处理；如果已处理，则直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免造成数据混乱。

#### ３)notifyUrl

- i.notifyUrl需要填写商户自己系统的真实地址，不能填写接口文档或demo上的示例地址，目前发邮件申请配置

- ii.notifyUrl必须是以https://或http://开头的完整全路径地址，并且确保url中的域名和IP是外网可以访问的，不能填写localhost、127.0.0.1、192.168.x.x等本地或内网IP。

- iii.常见错误举例：
错误示例 错误描述
http://www.xxxxx.com url中只有域名，缺少具体的路径
/apspay/payment url不是以https://或http://开头，缺少域名或IP
http://127.0.0.1/apspay/payment url中填写了本地或者内网IP
xxxxxxx，1234567，test 填写了不是url格式的字符串

#### 4) Transfereasy RSA公钥
由Transfereasy提供，用于贵公司对异步通知签名的验证，2048位（Base64 编码）。

测试环境：MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5yh6DNzuK5KV5NAQMuhQTwjMBKizVnntxM36CA+y7MUBFAeT1lh3Gq5nz+i6CgM69Gjur2TWqZGsQI42lUhfT552unxb0Zgamy290SmOFl1DGj/Q4thAQe1tXT5aWMAtrME0+FE+j2/8k9+t04qOCv/jg9yqxE0vYg5oFToWbDV7KVPpFSTIztSEseJhyTbFom2uwN0rztK8znQHL0BiSug6ImiOjLsgelpDgS7FaTPqJZJB6250QPodDe3DP2PRNjyrFMiT8pGRzsvUtzHrcWu24gRUuLgYesceSisEE+EBBVw/d4Rx/rDTlP+PIHpuLe0n5kOG01H32CBJRXM3SwIDAQAB

生产环境：MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzjpTME3ZqPmERY5U5/EEJZ2H3GitpXgwq0Sd4L99mIR+CyOZppUTG2grxFeqLi6gljPOj4VcorLf3Q9Vi46nYUyILcSopln5SPgyAXC+TzsC4HYVBTBoqNT6eSBnO8B8BvJ+oGe5DdqU4o8MJB3bLpTM2pIYXgrWU/XEWMHa7a0XAcbMYTcTn8FCNiSTrUjR2zliK89FFV5gAYOnzo4B6SFJ77BphbDgzA3wQRbZg2n46mMZKyGTuB09c3+g0S901/6NTCYvUA0SWMLI52muKVYxwiZNRaw/jdmSdOseWeawYSUkyl0M6Ho3WnSz+rJBcRauFA2mCl4ZBmBEJZtJOQIDAQAB

### 1.5 授权
#### 1.5.1 功能描述
获取token

#### 1.5.3 接口地址
请求地址：/api/v1/authentication

#### 1.5.4 请求参数说明

| 属性名称 | 属性含义 | 属性类型 | 长度限制	 | 说明 |
| --- | --- | --- | --- | --- |
| clientId |商户号  |String  | 8 | 商户号 |
| apiKey | 密钥 |String  | 100 |获取token密钥  |

#### 1.5.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")        |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

##### errorCode 为 200 时 data 返回下述参数

| 属性名称 | 属性含义 | 属性类型 | 长度限制	 | 说明 |
| --- | --- | --- | --- | --- |
|  access_token| token | String |400  | 30分钟有效期  |

## 2 易汇卡

### 2.1 申请易汇卡

#### 2.1.1 功能描述
申请易汇卡

#### 2.1.2 接口地址
请求地址：/vcc/card/createCard

#### 2.1.3 请求参数说明

| 属性名称          | 属性含义    | 属性类型   | 长度限制 | 说明                                       | 是否必填 |
|---------------|---------|--------|------|------------------------------------------|------|
| cardAddress   | 发卡地区    | String | 5    | 枚举值暂支持HK                                 | M    |
| cardTissue    | 卡组织     | String | 10   | 枚举值暂支持Discover                         | M    |
| cardBin    | 卡bin    | String | 10   | 枚举值 [附录：8](https://mrdoc.transfereasy.com/project-10/doc-52/ "附录：8")                     | M    |
| balanceNo     | 账户号     | String | 20   | 需要交易的账户号，请使用(5.1)查询账户接口获取 | M    |
| currency      | 币种      | String | 5    | 支持 [附录 ：10](https://mrdoc.transfereasy.com/project-10/doc-52/ "目录 ：10") 币种                              | M    |
| cardLimit     | 卡额度     | String | 20   | 金额格式:18.21 单位:元长度:整数位10，小数位2             | M    |
| beginQuota    | 单次限额起   | String | 20   | 金额格式:18.21 单位:元长度:整数位10，小数位2 | M    |
| endQuota      | 单次限额止   | String | 20   |金额格式:18.21 单位:元长度:整数位10，小数位2 | M    |
| cardUsageType      | 卡用途   | String | 3   |企业卡B2B，个人卡B2C | M    |

#### 2.1.4 请求参数示例：

```json
{
  "balanceNo": "10200000000000",
  "beginQuota": 0,
  "cardAddress": "HK",
  "cardBeginTime": "2023-11-15",
  "cardEndTime": "2024-11-15",
  "cardLimit": "100",
  "cardTissue": "Discover",
  "currency": "AUD",
  "endQuota": "100",
  "uesdCount": -1,
   "cardUsageType": "B2B"

}
```
#### 2.1.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false     |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 |
|----------------|-------|--------|------|----------------------------------|
| reqNo | 交易单号 | String | 30 | 交易单号 |
| currency | 卡币种 | String | 5 | 支持[附录 ：10](https://mrdoc.transfereasy.com/project-10/doc-52/ "目录 ：10") 币种 | 
| applyStatus | 申请状态 | String | 5 | PROCESSING： 申请中FAIL： 未通过SUCCESS 成功|
| cardTissue | 卡组织 | String | 10 | 枚举值暂支持Discover | M |
| cardBin | 卡bin | String | 10 | 枚举值 [附录：8]

#### 2.1.6 返回参数示例
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": {
    "cardBin": "658704", 
    "reqNo": "20250415155800000001",
    "currency": "USD",
    "cardTissue": "Discover",
    "applyStatus": "PROCESSING"
  }
}
```
 #### 2.1.7 备注
 申请卡返回信息是异步，根据 reqNo 交易单号，使用查询卡接口进行详细信息查询

### 2.2 充值易汇卡

#### 2.2.1 功能描述
充值易汇卡

#### 2.2.2 接口地址
请求地址：/vcccardrecharge/cardRecharge

#### 2.2.3 请求参数说明

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明                           | 是否必填 |
|--------|------|--------|------|------------------------------|------|
| cardId | 易汇卡卡id	   | String | 16   | 易汇卡卡id    | M    |
| balanceNo     | 账户号     | String | 20   | 需要交易的账户号 | M    |
| amount | 金额   | String | 13   | 金额格式:18.21 单位:元长度:整数位10，小数位2 | M    |

#### 2.2.4 请求参数示例：
```json
{
  "balanceNo": "102000000000000",
  "cardId":"APP0000000000000",
  "amount": "18.21"
}
```

#### 2.2.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false   |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")           |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称           | 属性含义  | 属性类型   | 长度限制 | 说明     |
|----------------|-------|--------|------|----------------------------------|
| cardId | 易汇卡卡id	   | String | 16   | 易汇卡卡id    |
| cardLogId      | 卡申请logid    | String | 64   | 易汇卡卡申请logid         |
| currency       | 卡币种   | String | 5    | 支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD 币种           |
| status         | 卡状态   | String | 5    | NORM:正常，SUSP:锁定，CLOP:预销卡，CLOS:销卡 |
| balance        | 卡可用余额 | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2    |
| ~~freezeBalance~~  | 冻结余额  | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2    |
| ~~settledBalance~~ | 清算金额  | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2    |

#### 2.2.6 返回参数示例
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": {
	"cardId":"APP0000000000000",
	"cardLogId":"13uu98ie0000000000000",
	"currency":"USD",
    "status": "NORM",
	"balance":"12.01"
  }
}
```

### 2.3 锁定易汇卡

#### 2.3.1 功能描述
锁定易汇卡

#### 2.3.2 接口地址
请求地址：/vcc/card/suspendCard

#### 2.3.3 请求参数说明

| 属性名称   | 属性含义  | 属性类型   | 长度限制 | 说明    | 是否必填 |
|--------|------|--------|------|-------|------|
| cardId | 卡id   | String | 16    | 易汇卡卡id | M    |

#### 2.3.4 请求参数示例：
```json
{
 	"cardId":"APP0000000000000"
}
```

#### 2.3.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明                               |
|--------|------|--------|------|----------------------------------|
| cardId | 卡id   | String | 16    | 易汇卡卡id |
| status | 卡状态  | String | 5    | NORM:正常，SUSP:锁定，CLOP:预销卡，CLOS:销卡 |

#### 2.3.6 返回参数示例

```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": {
    "cardId":"APP0000000000000",
    "status": "SUSP"
  }
}
```

### 2.4 解锁易汇卡

#### 2.4.1 功能描述
解锁易汇卡

#### 2.4.2 接口地址
请求地址：/vcc/card/unsuspendCard

#### 2.4.3 请求参数说明

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明    | 是否必填 |
|--------|------|--------|------|-------|------|
| cardId | 卡id   | String | 16    | 易汇卡卡id | M    |

#### 2.4.4 请求参数示例：
```json
{
 	"cardId":"APP0000000000000"
}
```

#### 2.4.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明                               |
|--------|------|--------|------|----------------------------------|
| cardId | 卡id   | String | 16    | 易汇卡卡id |
| status | 卡状态  | String | 5    | NORM:正常，SUSP:锁定，CLOP:预销卡，CLOS:销卡 |

#### 2.4.6 返回参数示例
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": {
	"cardId":"APP0000000000000",
    "status": "NORM"
  }
}
```

### 2.5 注销易汇卡

#### 2.5.1 功能描述
注销易汇卡

#### 2.5.2 接口地址
请求地址：/vcccardCancellation/closeCard

#### 2.5.3 请求参数说明

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明    | 是否必填 |
|--------|------|--------|------|-------|------|
| cardId | 卡id   | String | 16   | 易汇卡卡id | M    |

#### 2.5.4 请求参数示例：
```json
{
 	"cardId":"APP0000000000000"
}
```

#### 2.5.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明                               | 是否必填 |
|--------|------|--------|------|----------------------------------|------|
| cardId | 卡id   | String | 16    | 易汇卡卡id | M    |
| status | 卡状态  | String | 5    | NORM:正常，SUSP:锁定，CLOP:预销卡，CLOS:销卡 | M    |

#### 2.5.6 返回参数示例
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": {
	"cardId":"APP0000000000000",
    "status": "CLOP"
  }
}
```
#### 2.5.7 备注
根据有效期返回状态，单次卡跟多次卡在有效期都是预销卡状态。
不在有效期是销卡状态

### 2.6 查询易汇卡

#### 2.6.1 功能描述
查询易汇卡

#### 2.6.2 接口地址
请求地址：/vcc/card/findCardList

#### 2.6.3 请求参数说明

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明    | 是否必填 |
|--------|------|--------|------|-------|------|
| cardId | 卡id   | String | 5    | 易汇卡卡id,不传的话查询该商户下所有卡信息 | O    |

#### 2.6.4 请求参数示例：
```json
{
 	"cardId":"APP0000000000000"
}
```

#### 2.6.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称           | 属性含义  | 属性类型   | 长度限制 | 说明                               | 是否必填 |
|----------------|-------|--------|------|----------------------------------|------|
| cardNo         | 卡号    | String | 30   | 易汇卡卡号                                        | M    |
| cardId         | 卡ID    | String | 16   | 易汇卡卡id                                       | M    |
| cardLogId      | 卡申请logid    | String | 64   | 易汇卡卡申请logid                           | M    |
| currency       | 卡币种   | String | 5    | 支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD 币种    | M    |
| cardAddress       | 发卡地区   | String | 5    | 枚举值暂支持HK   | M    |
| cardTissue       | 卡组织   | String | 10    | 枚举值暂支持Discover   | M    |
| ~~cardProduct~~       | 卡产品   | String | 5    | 枚举值，C01；C02；C03；C04；C05，详见卡分类层次。   | M    |
| cardBin       | 卡BIN   | String | 20    | 发卡机构识别号   | M    |
| cardBeginTime       | 卡有效期 起   | String |20  | 卡有效期 起   | M    |
| cardEndTime       | 卡有效期 起   | String |20  | 卡有效期 止   | M    |
| cvv2       | 卡有效期 起   | String |20  | CVV 安全码   | M    |
| cardLimit       | 卡额度   | String |20  | 卡额度   | M    |
| beginQuota       | 单次限额 起   | String |20  | 单次限额 起   | M    |
| endQuota       | 单次限额 止   | String |20  | 单次限额 止   | M    |
| uesdCount       | 卡使用次数类型   | String |10  | 枚举值1:单次卡 -1:多次卡   | M    |
| cardExpirationDate       | 有效期   | String |10  | 卡有效期格式：ddMM   | M    |
| ~~cardType~~       | 卡类型   | String |10  | 枚举值，详见 附录 卡分类层次。   | M    |
| status         | 卡状态   | String | 5    | NORM:正常，SUSP:锁定，CLOP:预销卡，CLOS:销卡 | M    |
| balance        | 卡可用余额 | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2    | M    |
| ~~freezeBalance~~  | 冻结余额  | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2    | M    |
| ~~settledBalance~~ | 清算金额  | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2    | M    |
| cardUsageType      | 卡用途   | String | 3   |企业卡B2B，个人卡B2C | O    |
| reqNo         | 交易单号    | String | 30   | 交易单号               |

#### 2.6.6 返回参数示例
```json
{
	"success": true,
	"errorCode": 200,
	"errorMsg": "成功",
	"data": [
		{
			"cardAddress": "HK",
			"cvv2": "523",
			"cardBeginTime": "2023-09-08",
			"cardProduct": null,
			"settledBalance": 0,
			"cardEndTime": "2023-09-08",
			"endQuota": 1000,
			"cardType": "GWTTP",
			"reqNo": "f43856ea-44a5-4e69-a73b-xxxxxxxxxxxx",
			"beginQuota": 0,
			"cardTissue": "Discover",
			"cardNo": "73959xxxxxxxxxxxx",
			"cardBin": null,
			"balance": 1390,
			"cardExpirationDate": "2409",
			"cardId": "APPxxxxxxxxxxxx",
			"cardLogId": "27193xxxxxxxxxxxxxxxxxxxxxxxxxx",
			"currency": "HKD",
			"freezeBalance": 10,
			"uesdCount": 1,
			"cardLimit": 1400,
			"status": "NORM",
			"reqNo": "20250415155800000001"
		}
	]
}
```
### 2.7 查询订单数据

#### 2.7.1 功能描述
查询交易数据

#### 2.7.2 接口地址
请求地址：/vccledgers/findTranstionsListPage

#### 2.7.3 请求参数说明

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明    | 是否必填 |
|--------|------|--------|------|-------|------|
| cardLogId | 卡logId   | String |  64  | 易汇卡卡logid,不传的话查询该商户下所有卡信息 | O|
| cardId | 卡ID   | String | 16    | 易汇卡卡id,不传的话查询该商户下所有卡信息 | O|
| orderType | 订单类型   | String | 1    | 订单类型| O    |
| startTime | 开始时间   | String | 14    | 格式 yyyy-MM-dd | O    |
| endTime | 结束时间   | String | 14    | 格式 yyyy-MM-dd | O    |
| pageIndex | 分页页码   | Integer | 3    | 取值范围[1,100],默认值为1 | O    |
| pageSize | 分页条数   | Integer | 3    | 取值范围[1,100],默认值为10 | O    |

#### 2.7.4 请求参数示例：
```json
POST /vccledgers/findTranstionsListPage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJTSElXRUlXRUkiLCJyb3V0ZXJMaXN0IjpudWxsLCJleHAiOjE3MDA2MjAwMDEsImlhdCI6MTcwMDYxODIwMSwicm9sIjpbeyJhdXRob3JpdHkiOiJST0xFX0FETUlOIn1dLCJtdWx0aXN0YWdlTm8iOiIxNjYwNzE1OTExNTYwIiwiZW1haWwiOiJzaGl3ZWl3ZWlAdHJhbnNmZXJlYXN5LmNvbSIsImp0aSI6IjM5ODE2Nzc2NiJ9._Ch-aNEnKxcsu95UqBfeE-Ayrw_H2xSb6TT_Epxia8zl5PxhuNMOUvKV1-wLD-VPqyu3xx9Me-y0FaWkvz3QAw
Content-Type: application/json
User-Agent: PostmanRuntime/7.35.0
Accept: */*
Cache-Control: no-cache
Postman-Token: ffb8ad41-95d0-4241-9b99-03379eede4bb
Host: test-merchant-api.transfereasy.com
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 187
 
{
"cardLogId": "e9e87af00227bf29748bbafa820c2b31c602a75a545d9629aadf878c9821100e",
"startTime": "2023-10-29",
"endTime": "2023-10-31",
"pageIndex": 1,
"pageSize": 10
}
```

#### 2.7.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 | 是否必填 |
|----------------|-------|--------|------|----------------------------------|------|
| orderNo | 订单号 | String | 48 | 订单号 | M |
| orderType | 订单类型 | String | 1 | 1：消费2：结算 [附录2：订单状态](https://mrdoc.transfereasy.com/project-10/doc-52/ "附录2：订单类型") | M |
| cardLogId | 卡logid | String | 64 | 易汇卡logid | M |
| transactionTime | 交易发生时间 | String | 18 | 例如2023-10-30 17:27:25 | M |
| transCurrency | 交易币种 | String | 3 | 发生交易的币种 [附录：币种](https://mrdoc.transfereasy.com/modify_doc/52/ "附录：币种") | O |
| transCurrencyAmt | 交易金额 | String | 13 | 发生交易的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2 | O |
| localCurrency | 卡币种 | String | 3 | 卡币种 [附录：币种](https://mrdoc.transfereasy.com/modify_doc/52/ "附录：币种") | O |
| localCurrencyAmt | 卡交易金额 | String | 13 | 以卡币种为单位的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2 | O |
| feeCurrency | 手续费币种 | String | 3 | 手续费币种 [附录：币种](https://mrdoc.transfereasy.com/modify_doc/52/ "附录：币种") | O |
| fee | 手续费金额 | String | 13 | 手续费金额，金额格式:18.21。单位:元。长度:整数位10，小数位2 | O |
| approveCode | 授权码 | String | 3 | 随机6位数字。 | O |
| merchantName | 商户名称	 | String | 48 | 商户名称	 | O |
| merchantCountry | 商户所在国家 | String | 3 | 商户所在国家 | O |
| status | 订单状态 | String | 24 | 订单状态 [附录3,4,5：订单状态](https://mrdoc.transfereasy.com/project-10/doc-52/ "附录3,4,5") | O |
| statusMsg | 描述信息 | String | 100 | 描述信息 | O |
| settleTime | 入账时间 | String | 100 | 入账时间 | O |
| settleAmt | 清算金额 | String | 16 | 清算金额 | O |
| merchantCategoryCode | 商户MCC信息 | String | 16 | 商户MCC信息 | O |

#### 2.7.6 返回参数示例
```json
{
	"success": true,
	"errorCode": 200,
	"errorMsg": "成功",
	"data": {
		"dataList": [
			{
			"cardLogId": "510506569571",
			"transactionTime": "2025-03-06 10:46:18",
			"orderType": "1",
			"orderNo": "20250306100800000001",
			"merchantName": "Issuer Script",
			"transCurrencyAmt": 10,
			"transCurrency": "USD",
			"settleAmt": 0,
			"localCurrency": null,
			"settleTime": null,
			"localCurrencyAmt": 10,
			"merchantCountry": "US",
			"merchantCategoryCode": "5815",
			"approveCode": "475847",
			"fee": 1.1,
			"feeCurrency": "USD",
			"statusMsg": "Insufficient funds/over credit limit.",
			"status": "REFUND_AUTH_NO_SETTLE"
		  }
		]
	}
}
```
### 2.8 授权结果通知

#### 2.8.1 功能描述
授权结果通知

#### 2.8.2 地址
请求地址：商户所配置异步通知地址

#### 2.8.3 请求参数说明

| 属性名称           | 属性含义  | 属性类型   | 长度限制 | 说明                               | 是否必填 |
|----------------|-------|--------|------|----------------------------------|------|
| msgType         | 通知类型    | String | 48   | 通知类型 VCC_AUTH     | M    |
| txnId         | 交易唯一ID    | String | 48   | 交易唯一ID                               | M    |
| orderNo         | TE交易关联ID    | String | 48   | TE交易关联ID  | M    |
| transactionId         | 通道交易关联ID    | String | 48   | 通道交易关联ID  | M    |
| cardLogId      | 卡logid    | String | 64   | 易汇卡logid         | M    |
| transactionTime       | 交易发生时间   | String | 18    | 例如2023-10-30 17:27:25 | M    |
| transCurrency | 交易币种   | String | 3    | 发生交易的币种 | O    |
| transCurrencyAmt | 交易金额 | String | 13   | 发生交易的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2 | O    |
| localCurrency  | 卡币种  | String | 3   | 卡币种    | M   |
| localCurrencyAmt | 卡交易金额  | String | 13   | 以卡币种为单位的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2    | M   |
| approvalCode  | 授权码  | String | 3   | 随机6位数字。    | O   |
| merchantId  | 商户ID	  | String | 48   |     | O   |
| merchantName  | 商户名称	  | String | 48   | 商户名称	    | O   |
| merchantCategoryCode  | 商户MCC	  | String | 48   | 商户MCC	    | O   |
| merchantCountry  | 商户所在国家  | String | 3   | 商户所在国家    | O   |
| merchantCity  | 商户所在城市  | String | 20   | 商户所在城市    | O   |
| acquirerId  | 收单行ID	  | String | 64   | 收单行ID	    | O   |
| crossBorderType  | 交易是否跨境	  | String | 64   |0：境内；1：境外    | O   |
| messageType  | 交易类型	  | String | 4   | 详见授权类型    | O   |
| messageTypeDesc  | 交易类型描述  | String | 64  | 交易类型描述    | O   |
| respCode  | 交易类型描述  | String | 4  | 枚举值，4位数字，详见授权响应码下拉框。	    | O   |
| respCodeDesc  | 交易响应码描述  | String | 64  | 交易响应码描述    | O   |

#### 2.8.4返回参数
```
商户需返回 "SUCCESS"字样

```

### 2.9 查询授权/清算数据

#### 2.9.1 功能描述
查询授权/清算数据

#### 2.9.2 接口地址
请求地址：api/v1/vcc/findTxnListPage

#### 2.9.3 请求参数说明

| 属性名称   | 属性含义 | 属性类型   | 长度限制 | 说明    | 是否必填 |
|--------|------|--------|------|-------|------|
| cardLogId | 卡logId | String | 64 | 易汇卡卡logid,不传的话查询该商户下所有卡信息| O    |
| cardId | 卡ID   | String | 16    | 易汇卡卡id,不传的话查询该商户下所有卡信息 | O|
| orderType | 订单类型   | String | 1    | 订单类型 :1授权 2清算| M    |
| startTime | 开始时间   | String | 14    | 格式 yyyy-MM-dd | M  |
| endTime | 结束时间   | String | 14    | 格式 yyyy-MM-dd | M    |
| pageIndex | 分页页码   | Integer | 3    | 取值范围[1,100],默认值为1 | O    |
| pageSize | 分页条数   | Integer | 3    | 取值范围[1,100],默认值为10 | O    |

#### 2.9.4 请求参数示例：
```json
POST /api/v1/vcc/findTxnListPage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJHRiBTT0NJRVRBJ0EgUkVTUE9OU0FCSUxJVEEnIExJTUlUQVRBIFNFTVBMSUZJQ0FUQSIsInJvdXRlckxpc3QiOm51bGwsImV4cCI6MTcwMTUwNTEyOCwiaWF0IjoxNzAxNTAzMzI4LCJyb2wiOltdLCJtdWx0aXN0YWdlTm8iOiIxNjQ3NTE0ODAzNDk0IiwiZW1haWwiOiJodW9ob25vOThAMTYzLmNvbSIsImp0aSI6IjgwMDAwMjkwIn0.tdaBUctlIN3J2-7hKdSii3ZotQCKzAsPrfTAYBLY62yHb8cQusoA9uGsUfzNkcp_e19Vu3kVzsIk2xSYNEE2Yw
request-id: 17b690e3-5a10-448b-91c4-a8f8e936ebfb
Content-Type: application/json
User-Agent: PostmanRuntime/7.35.0
Accept: */*
Cache-Control: no-cache
Postman-Token: 28c8769a-56f7-4323-a643-caf47f91a8b9
Host: 127.0.0.1:8090
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 124
 
{
"startTime": "2023-11-01",
"endTime": "2023-11-30",
"orderType": "1",
"pageIndex": 1,
"pageSize": 10
}
```

#### 2.9.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称           | 属性含义  | 属性类型   | 长度限制 | 说明                               | 是否必填 |
|----------------|-------|--------|------|----------------------------------|------|
| txnId         | 交易唯一ID    | String | 48   | 交易唯一ID                               | M    |
| orderNo         | TE交易关联ID    | String | 48   | TE交易关联ID  | M    |
| transactionId         | 通道交易关联ID    | String | 48   | 通道交易关联ID  | M    |
| orderType         | 订单类型    | String | 1   | 1授权 2清算  | M    |
| cardLogId      | 卡logid    | String | 64   | 易汇卡logid         | M    |
| messageType      | 交易类型    | String | 64   | 交易类型 | M    |
| messageTypeDesc      | 交易类型描述    | String | 64   | 交易类型描述| M    |
| respCode      | 交易响应码    | String | 64   | 交易响应码  | M    |
| respCodeDesc      | 交易响应码描述    | String | 64   | 交易响应码描述   | M    |
| transactionTime | 交易发生时间   | String | 18    | 例如2023-10-30 17:27:25 | M    |
| postingDateTime  | 入账处理时间   | String | 18    | 订单类型为2时返回 。例如2023-10-30 17:27:25 | M    |
| transCurrency | 交易币种   | String | 3    | 发生交易的币种 | O    |
| transCurrencyAmt | 交易金额 | String | 13   | 发生交易的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2 | O    |
| localCurrency  | 卡币种  | String | 3   | 卡币种    | M   |
| localCurrencyAmt | 卡交易金额  | String | 13   | 以卡币种为单位的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2    | M   |
| accountCurrency  | 清算币种  | String | 3   | 清算币种 :订单类型为2时返回   | C   |
| billAccountAmount | 清算金额  | String | 13   | 清算币种为单位的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2  。订单类型为2时返回   | C  |
| feeCurrency  | 手续费币种  | String | 3   | 手续费币种    | O   |
| fee | 手续费金额  | String | 13   | 手续费金额，金额格式:18.21。单位:元。长度:整数位10，小数位2    | O   |
| approvalCode  | 授权码  | String | 3   | 随机6位数字。    | O   |
| merchantId  | 商户ID	  | String | 48   |     | O   |
| merchantName  | 商户名称	  | String | 48   | 商户名称	    | O   |
| merchantCategoryCode  | 商户MCC	  | String | 48   | 商户MCC	    | O   |
| merchantCountry  | 商户所在国家  | String | 3   | 商户所在国家    | O   |
| merchantCity  | 商户所在城市  | String | 20   | 商户所在城市    | O   |
| acquirerId  | 收单行ID	  | String | 64   | 收单行ID	    | O   |

#### 2.9.6返回参数示例：
```json
{
    "success": true,
    "errorCode": 200,
    "errorMsg": "成功",
    "data": {
        "total": 1,
        "dataList": [
            {
                "txnId": "aa70b5c4-c327-4280-a52c-6417f69c4b35",
                "transactionId": "1101124715801666015471",
                "orderNo": "20231107180700000013",
                "orderType": "1",
                "cardLogId": "3b2ecXXXXXXXXXXX",
                "transactionTime": "2023-11-01 20:47:15",
                "messageType": "6810",
                "messageTypeDesc": null,
                "respCode": "0000",
                "respCodeDesc": "Authorization Approval",
                "transCurrency": "EUR",
                "transCurrencyAmt": 39.00,
                "localCurrency": "EUR",
                "localCurrencyAmt": 39.00,
                "fee": 0.00,
                "feeCurrency": "EUR",
                "approveCode": "M61K8J",
                "merchantId": "002805695",
                "merchantName": "BISCEGLIE M1",
                "merchantCategoryCode": "4111",
                "merchantCountry": "IT",
                "merchantCity": "MILANO",
                "acquirerId": "015471",
                "postingDateTime": "2023-11-02 05:47:15",
                "accountCurrency": "EUR",
                "billAccountAmount": 39.00
            }
        ]
    }
}
```
## 3 相关接口
### 3.1 账户流水

#### 3.1.1 功能描述
账户流水

#### 3.1.2 接口地址
请求地址：/vccledgers/balanceLedgersListByPage

#### 3.1.3 请求参数说明

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 | 是否必填 |
|---------------|---------|--------|------|------------------------------------------|------|
| borrowLend | 方向 | String | 5 | 枚举值,DR:支出;CR:收入 | O |
| currency | 币种 | String | 10 | 支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD 币种 | O |
| accountBalanceNo | 账户号 | String | 20 | 交易的账户号 | O |
| orderNo | 订单号 | String | 20 | 交易的订单号 | O |
| tradeType | 类型 | String | 50 | 枚举值 SHIFT_TO:易汇卡账户入金 TRANSFER_OUT:易汇卡账户出金 CREATE_CARD:开卡入金 EXPENDITURE_AUTHORIZATION:消费授权 EXPENDITURE_SETTLE:消费清算 EXPENDITURE_AUTHORIZATION_REVERSAL:消费授权冲正 REFUND_AUTHORIZATION:退款授权 REFUND_SETTLE:退款清算 REFUND_AUTHORIZATION_REVERSAL:退款授权冲正 DISPUTE:消费争议 DISPUTE_SUCCESS:争议释放 CARD_CANCELLATION:销卡退款 CARD_RECHARGE:卡充值 AUTHORIZATION_QUERY:授权查询 CONSUMPTION_DEDUCTION:消费补扣 CONSUMPTION_RETURN:消费退回 SHIFT_TO_FEE:易汇卡账户入金手续费 TRANSFER_OUT_FEE:易汇卡账户出金手续费 CREATE_CARD_FEE:开卡手续费 AUTHORIZE_FEE:授权手续费 DISPUTE_FEE:争议手续费 CANCEL_CARD_FEE:销卡手续费 RECHARGE_FEE:充值手续费 SETTLE_REVERSAL:清算冲正 CARD_WITHDRAWAL:卡提现 | O |
| startTime | 入账时间(起) | String | 20 | 字符串类型的时间格式:yyyy-MM-dd HH:mm:ss 例:2023-11-15 00:00:00 | M |
| endTime | 入账时间(止) | String | 20 | 字符串类型的时间格式:yyyy-MM-dd HH:mm:ss 例:2023-11-15 00:00:00 | M |
| pageIndex | 分页页码 | Integer | 10 | 取值范围[1,100],默认值为1。 | O |
| pageSize | 分页条数	 | Integer | 20 | 取值范围[1,100],默认值为10。 | O |

#### 3.1.4 请求参数示例：

```json
{
  "startTime": "2023-11-16 00:00:00",
  "endTime": "2023-11-17 23:59:59",
  "balanceNo": "102000000000000000",
  "orderNo": "20231100000000000001",
  "currency": "",
  "borrowLend": "",
  "tradeType": "",
  "pageIndex": 1,
  "pageSize": 100
}
```
#### 3.1.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")          |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 | 是否必填 |
|----------------|-------|--------|------|----------------------------------|------|
| accountNo | 商户号 | String | 10 | 商户号 | M |
| accountName | 商户名称 | String | 50 | 商户名称 | M |
| accountBalanceNo | 账户号 | String | 20 | 账户号 | M |
| accountBalanceName | 账户名称 | String | 50 | 账户名称 | M |
| orderNo | 订单号 | String | 50 | 订单号 | M |
| currency | 币种 | String | 50 | 支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD 币种 | M |
| borrowLend | 方向 | String | 5 | 枚举值,DR:支出;CR:收入 | M |
| tradeType | 类型 | String | 50 | 枚举值 SHIFT_TO:易汇卡账户入金 TRANSFER_OUT:易汇卡账户出金 CREATE_CARD:开卡入金 EXPENDITURE_AUTHORIZATION:消费授权 EXPENDITURE_SETTLE:消费清算 EXPENDITURE_AUTHORIZATION_REVERSAL:消费授权冲正 REFUND_AUTHORIZATION:退款授权 REFUND_SETTLE:退款清算 REFUND_AUTHORIZATION_REVERSAL:退款授权冲正 DISPUTE:消费争议 DISPUTE_SUCCESS:争议释放 CARD_CANCELLATION:销卡退款 CARD_RECHARGE:卡充值 AUTHORIZATION_QUERY:授权查询 CONSUMPTION_DEDUCTION:消费补扣 CONSUMPTION_RETURN:消费退回 SHIFT_TO_FEE:易汇卡账户入金手续费 TRANSFER_OUT_FEE:易汇卡账户出金手续费 CREATE_CARD_FEE:开卡手续费 AUTHORIZE_FEE:授权手续费 DISPUTE_FEE:争议手续费 CANCEL_CARD_FEE:销卡手续费 RECHARGE_FEE:充值手续费 SETTLE_REVERSAL:清算冲正 CARD_WITHDRAWAL:卡提现 | M |
| changePrice | 交易金额 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| endAmount | 可用余额 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| freezeAmount | 冻结余额 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| unsettleAmount | 未结算余额 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| accountingTime | 入账时间 | String | 20 | 字符串类型的时间格式:yyyy-MM-dd HH:mm:ss 例:2023-11-15 00:00:00 | M |

#### 3.1.6 返回参数示例
```json
{
	"success": true,
	"errorCode": 200,
	"errorMsg": "成功",
	"data": [
		{
			"accountNo": "300000001",
			"accountName": "测试",
			"orderNo": "20231100000000000001",
			"accountBalanceNo": "102000000000000000",
			"accountBalanceName": "测试",
			"currency": "HKD",
			"borrowLend": "DR",
			"changePrice": 100,
			"endAmount": 61459.78,
			"freezeAmount": 17923.76,
			"unsettleAmount": 0,
			"tradeType": "CREATE_CARD",
			"accountingTime":"2023-11-17 23:59:59"
		},
		{
			"accountNo": "300000001",
			"accountName": "测试",
			"orderNo": "20231100000000000001",
			"accountBalanceNo": "102000000000000000",
			"accountBalanceName": "测试",
			"currency": "HKD",
			"borrowLend": "DR",
			"changePrice": 20,
			"endAmount": 61559.78,
			"freezeAmount": 17823.76,
			"unsettleAmount": 0,
			"tradeType": "CREATE_CARD_FEE",
			"accountingTime":"2023-11-17 23:59:59"
		}
	]
}
```

### 3.2 卡流水

#### 3.2.1 功能描述
卡流水

#### 3.2.2 接口地址
请求地址：/vccledgers/cardLedgersQueryByPage

#### 3.2.3 请求参数说明

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 | 是否必填 |
|---------------|---------|--------|------|------------------------------------------|------|
| borrowLend | 方向 | String | 5 | 枚举值,DR:支出;CR:收入 | O |
| cardCurrency | 币种 | String | 10 | 支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD 币种 | O |
| orderNo | 订单号 | String | 20 | 交易的订单号 | O |
| cardId | 卡Id | String | 20 | 卡Id | O |
| ledgersType | 流水类型 | String | 50 | 枚举值 CREATE_CARD:申卡入金 CARD_RECHARGE:卡充值 EXPENDITURE_AUTHORIZATION:消费授权 EXPENDITURE_AUTHORIZATION_REVERSAL:消费授权冲正 REFUND_AUTHORIZATION_SETTLE:消费退款清算 EXPENDITURE_SETTLE:消费清算 REFUND_AUTHORIZATION_REVERSAL:退款授权冲正 CONSUMPTION_DEDUCTION:消费补扣 CONSUMPTION_RETURN:消费退回 CARD_CANCELLATION:销卡出金 CARD_WITHDRAWAL:卡提现 | O |
| startTime | 入账时间(起) | String | 20 | 字符串类型的时间格式:yyyy-MM-dd HH:mm:ss 例:2023-11-15 00:00:00 | M |
| endTime | 入账时间(止) | String | 20 | 字符串类型的时间格式:yyyy-MM-dd HH:mm:ss 例:2023-11-15 00:00:00 | M |
| pageIndex | 分页页码 | Integer | 10 | 取值范围[1,100],默认值为1。 | O |
| pageSize | 分页条数	 | Integer | 20 | 取值范围[1,100],默认值为10。 | O |

#### 3.2.4 请求参数示例：

```json
{
    "startTime": "2023-11-16 00:00:00",
    "endTime": "2023-11-17 23:59:59",
    "cardId": "APP000000000000",
    "orderNo": "20231100000000000001",
	"borrowLend": "",
    "ledgersType": "CREATE_CARD",
    "cardCurrency": "HKD",
    "pageIndex": 1,
    "pageSize": 10
}
```
#### 3.2.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")         |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 | 是否必填 |
|----------------|-------|--------|------|----------------------------------|------|
| cardId | 卡ID | String | 16 | 易汇卡卡id | M |
| transTime | 交易时间 | String | 20 | 交易时间 | M |
| accountNo | 商户号 | String | 64 | 商户号 | M |
| orderNo | 订单号 | String | 64 | 订单号 | M |
| ledgersType | 流水类型 | String | 50 | 枚举值 CREATE_CARD:申卡入金 CARD_RECHARGE:卡充值 EXPENDITURE_AUTHORIZATION:消费授权 EXPENDITURE_AUTHORIZATION_REVERSAL:消费授权冲正 REFUND_AUTHORIZATION_SETTLE:消费退款清算 EXPENDITURE_SETTLE:消费清算 REFUND_AUTHORIZATION_REVERSAL:退款授权冲正 CONSUMPTION_DEDUCTION:消费补扣 CONSUMPTION_RETURN:消费退回 CARD_CANCELLATION:销卡出金 CARD_WITHDRAWAL:卡提现 | M |
| borrowLend | 方向 | String | 5 | 枚举值,DR:支出;CR:收入 | M |
| cardTransAmount | 卡交易金额 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| cardCurrency | 卡币种 | String | 5 | 卡币种 | M |
| balanceType | 动账类型 | String | 5 |枚举值 ACCOUNT_BALANCE:卡可用资金 SETTLED_BALANCE:卡已入账资金 FREEZE_BALANCE:卡未结算资金 | M |
| cardAvailableAmount | 卡可用金额 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| cardUnsettleAmount | 卡未结算资金 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| cardSettledAmount | 卡清算金额 | String | 13 | 金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| remarks | 备注 | String | 500 | 备注 | M |
| serialNo | 流水号 | String | 500 | 流水号 | M |
| txnId | txnId| String | 48 | 清算/授权订单 唯一id | M |

#### 3.2.6 返回参数示例
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": [
    {
      "cardId": "APP0000000000000",
      "transTime": "2023-11-17 11:23:20",
      "accountNo": "300000000",
      "orderNo": "20230000000000000000",
      "ledgersType": "CREATE_CARD",
      "borrowLend": "CR",
      "cardTransAmount": 100,
      "cardCurrency": "HKD",
      "balanceType": "ACCOUNT_BALANCE",
      "cardAvailableAmount": 100,
      "cardUnsettleAmount": 0,
      "cardSettledAmount": 0,
      "remarks": null
    }
  ]
}
```
### 3.3 卡管理

#### 3.3.1 功能描述
卡管理接口，包括卡片的开卡，充值，销卡，提现数据

#### 3.3.2 接口地址
请求地址：/vccledgers/cardTransactionsQueryByPage

#### 3.3.3 请求参数说明

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 | 是否必填 |
|---------------|---------|--------|------|------------------------------------------|------|
| cardNo | 卡号 | String | 20 | 卡号 | O |
| cardId | 卡Id | String | 20 | 卡Id | O |
| orderNo | 订单号 | String | 20 | 交易的订单号 | O |
| orderType | 订单类型 | String | 20 | 枚举值 "3":充值 "4":开卡 "5":销卡 "6":提现 | O |
| status | 订单状态 | String | 20 | 枚举值 SUCCESS:成功 PROCESSING:处理中 FAIL:失败 | O |
| startTime | 入账时间(起) | String | 20 | 字符串类型的时间格式:yyyy-MM-dd HH:mm:ss 例:2023-11-15 00:00:00 | M |
| endTime | 入账时间(止) | String | 20 | 字符串类型的时间格式:yyyy-MM-dd HH:mm:ss 例:2023-11-15 00:00:00 | M |
| pageIndex | 分页页码 | Integer | 10 | 取值范围[1,100],默认值为1。 | O |
| pageSize | 分页条数	 | Integer | 20 | 取值范围[1,100],默认值为10。 | O |

#### 3.3.4 请求参数示例：

```json
{
"cardNo": "7395xxxxxxxxxxxxxx",
"cardID": "APPxxxxxxxxx",
"orderNo": "202310xxxxxxxxx",
"orderType": "3",
"status": "SUCCESS",
"startTime": "2024-08-01 00:00:00",
"endTime": "2024-10-15 00:00:00",
"pageIndex": 1,
"pageSize": 10
}
```
#### 3.3.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称 | 属性含义 | 属性类型 | 长度限制 | 说明 | 是否必填 |
|----------------|-------|--------|------|----------------------------------|------|
| cardNo | 卡号 | String | 16 | 易汇卡卡号 | M |
| cardId | 卡ID | String | 16 | 易汇卡卡id | M |
| orderNo | 订单号 | String | 64 | 订单号 | M |
| orderType | 订单类型 | String | 20 | 枚举值 "3":充值 "4":开卡 "5":销卡 "6":提现 | M |
| status | 订单状态 | String | 20 | 枚举值 SUCCESS:成功 PROCESSING:处理中 FAIL:失败 | M |
| transactionTime | 交易时间 | String | 20 | 交易时间 | M |
| transCurrency | 交易币种 | String | 3 | 发生交易的币种 | M |
| transCurrencyAmt | 交易金额 | String | 13 | 发生交易的金额，金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |
| feeCurrency | 手续费币种 | String | 3 | 手续费币种 | M |
| fee | 手续费金额 | String | 13 | 手续费金额，金额格式:18.21。单位:元。长度:整数位10，小数位2 | M |

#### 3.3.6 返回参数示例
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": [
    {
      "cardNo": "111111******6672",
      "cardId": "XR183xxxxxxxxxxx",
      "orderType": "6",
      "transCurrencyAmt": 111,
      "transCurrency": "USD",
      "orderNo": "20240927160200000001",
      "transactionTime": "2024-09-27 16:02:15",
      "status": "SUCCESS",
      "fee": 1.12,
      "feeCurrency": "USD"
    }
  ]
}
```
### 3.4 卡交易邮件通知
#### 3.4.1功能描述
卡交易通知邮箱
#### 3.4.2 接口地址
/vcc/card/vccCardEmails
#### 3.4.3 请求参数说明
| 属性名称                  | 属性含义  | 属性类型   | 长度限制 | 说明                                       | 是否必填 |
|-----------------------|-------|--------|------|------------------------------------------|------|
| cardId         | 卡ID    | String | 16   | 易汇卡卡id                 | M    |
|notifyEmails | 交易成功通知邮箱 |Text | --- | 多个以英文“,”隔开|M|
|notifyFailEmails | 交易失败通知邮箱 |Text | --- | 多个以英文“,”隔开|M|
#### 3.4.4 请求参数示例：
```json
{
"cardID": "APPxxxxxxxxx",
"notifyEmails": "XXXX@XXX.com,XXXX@XXX.com",
"notifyFailEmails": "XXXX@XXX.com,XXXX@XXX.com",
}
```
#### 3.3.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |

### 4.1 账户转入转出
#### 4.1.1 功能描述
账户转入转出

#### 4.1.2 接口地址
请求地址: /moves/balanceMoves

#### 4.1.3 请求参数说明

| 属性名称                  | 属性含义  | 属性类型   | 长度限制 | 说明                                       | 是否必填 |
|-----------------------|-------|--------|------|------------------------------------------|------|
| beneficiaryAccountNo  | 收款商户号 | String | 20   | 收款商户号                                    | M    |
| beneficiaryAccountNum | 收款账户号 | String | 20   | 收款账户号                                    | M    |
| beneficiaryAccountName | 收款账户名 | String | 20   | 收款账户名                                    | M    |
| payerAccountNum       | 支付账户号 | String | 20   | 支付账户号                                    | M    |
| currency              | 币种    | String | 20   | 币种支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD | M    |
| amount                | 金额    | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2            | M    |

#### 4.1.4 请求参数示例：
```json
{
        "beneficiaryAccountNo": "398167820",
        "beneficiaryAccountNum": "10100000000000",
		"beneficiaryAccountName":"测试",
        "payerAccountNum": "10200000000000",
        "currency": "HKD",
        "amount": 10
}
```

#### 4.1.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称                  | 属性含义  | 属性类型   | 长度限制 | 说明                                       | 是否必填 |
|-----------------------|-------|--------|------|------------------------------------------|------|
| order                 | 订单号   | String | 20   | 订单号                                      | M    |
| beneficiaryAccountNum | 收款账户号 | String | 20   | 收款账户号                                    | M    |
| beneficiaryAccountName | 收款账户名 | String | 20   | 收款账户名                                    | M    |
| payerAccountNum       | 支付账户号 | String | 20   | 支付账户号                                    | M    |
| currency              | 币种    | String | 20   | 币种支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD | M    |
| amount                | 金额    | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2            | M    |

#### 4.1.4 返回参数示例：
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": {
    "order": "210399000000000000",
    "beneficiaryAccountNum": "10102134400000000",
    "beneficiaryAccountName": "测试",
    "payerAccountNum": "10202134400000000",
    "currency": "HKD",
    "amount": 10
  }
}
```

### 5.1 账户查询
#### 5.1.1 功能描述
账户信息查询

#### 5.1.2 接口地址
请求地址:/account_te/findVccBalanceList

#### 5.1.3 请求参数说明

| 属性名称                  | 属性含义  | 属性类型   | 长度限制 | 说明                                       | 是否必填 |
|-----------------------|-------|--------|------|------------------------------------------|------|
| 无|

#### 5.1.4 请求参数示例：
```json
{}
```

#### 5.1.5 返回参数说明

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| success | 请求状态   | 成功true,请求已接收；失败false      |
| errorCode   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-10/doc-52/ "详见业务状态码")            |
| errorMsg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### errorCode 为 200 时 data 返回下述参数

| 属性名称            | 属性含义    | 属性类型   | 长度限制 | 说明                                       | 是否必填 |
|-----------------|---------|--------|------|------------------------------------------|------|
| area            | 地区      | String | 20   | 地区编码,详情请看                                | M    |
| balanceType     | 账户类型    | String | 4    | 枚举值,1010:TE账户,1020:易汇卡账户                 | M    |
| balanceNo       | 账户号     | String | 20   | 支付账户号                                    | M    |
| balanceName     | 账户名     | String | 300  | 账户名                                      | M    |
| currency        | 币种      | String | 20   | 币种支持 USD/CAD/AUD/HKD/GBP/EUR/JPY/SGD/NZD | M    |
| balanceStatus   | 账户状态    | String | 1    | 枚举值，0：冻结 1：正常                            | M    |
| ~~totalBalance~~    | 账户总金额   | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2            | M    |
| accountBalance  | 账户可用金额  | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2            | M    |
| ~~freezeBalance~~   | 账户冻结余额  | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2            | M    |
| ~~unsettleBalance~~ | 账户未结算余额 | String | 13   | 金额格式:18.21。单位:元。长度:整数位10，小数位2            | M    |

#### 5.1.6 返回参数示例：
```json
{
  "success": true,
  "errorCode": 200,
  "errorMsg": "成功",
  "data": [
    {
      "area": "HK",
      "balanceType": 1010,
      "balanceNo": "10102100000000000",
      "balanceName": "测试1",
      "balanceStatus": 1,
      "currency": "AUD",
      "accountBalance": 0
    },
    {
      "area": "HK",
      "balanceType": 1010,
      "balanceNo": "10102100000000000",
      "balanceName": "测试2",
      "balanceStatus": 1,
      "currency": "CAD",
      "accountBalance": 588.31
    }
  ]
}
```