API文档
简体中文

公共参数

服务端接口公共请求参数

参数 取值 必传 类型 备注
api_key 5G66cd41ab99651-EREDRERS 字符串 apiKey
timestamp 1746783841 整数 请求时间戳秒
sign 9c062a8d614c84d0ea6debb... 字符串 签名

签名方法

请参考 基本信息 >> 快速开始 >> 签名方式

客户端接口公共请求参数

参数 取值 必传 类型 备注
app_id 5G66cd41ab99651-EREDRERS 字符串 从 clientConfig 接口中获取
timestamp 1746783841 整数 请求时间戳秒
sign 9c062a8d614c84d0ea6debb... 字符串 签名
token 9c062a8d614c84d0ea6debb... 字符串 从 /account/token 接口获取

签名方法

请参考 基本信息 >> 快速开始 >> 签名方式

这里签名使用的 api_secret 是从 clientConfig 接口获取的 client_secret!!!

账户 - 服务端

创建账号

通过用户唯一标识符注册新的用户账户

HTTP请求:

请求参数

参数 取值 必传 类型 备注
m_user_id uid2025061012492501 字符串 用户唯一标识符
nickname Jack 字符串 用户昵称

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-12 10:15:21",
        "unique": "684a38391851e1430814062",
        "runtime": "35.72 ms"
    },
    "data": {
        "m_user_id": "eric_test_02",
        "user_id": 10100016243,
        "merchant_id": 100034,
        "channel_id": 100034,
        "nickname": "eric_test_02",
        "status": 1,
        "create_time": 1749694365,
    },
    "microtime": 1749694521135
}

返回结构

参数 类型 备注
m_user_id 字符串 自定义用户编号(唯一)
user_id 整数 UID
merchant_id 整数 商户 ID
channel_id 整数 渠道 ID
nickname 字符串 用户昵称
status 整数 状态
create_time 整数 创建时间

账号详情

获取某已注册用户的账户基础信息

HTTP请求:

请求参数

参数 取值 必传 类型 备注
m_user_id uid2025061012492501 字符串 用户唯一标识符

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-12 10:15:21",
        "unique": "684a38391851e1430814062",
        "runtime": "35.72 ms"
    },
    "data": {
        "m_user_id": "eric_test_02",
        "user_id": 10100016243,
        "merchant_id": 100034,
        "channel_id": 100034,
        "nickname": "eric_test_02",
        "status": 1,
        "create_time": 1749694365,
    },
    "microtime": 1749694521135
}

返回结构

参数 类型 备注
m_user_id 字符串 自定义用户编号(唯一)
user_id 整数 UID
merchant_id 整数 商户 ID
channel_id 整数 渠道 ID
nickname 字符串 用户昵称
status 整数 状态
create_time 整数 创建时间

更新账号

更新某用户的昵称

HTTP请求:

请求参数

参数 取值 必传 类型 备注
m_user_id uid2025061012492501 字符串 用户唯一标识符
nickname Jack 字符串 用户昵称

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-12 10:15:21",
        "unique": "684a38391851e1430814062",
        "runtime": "35.72 ms"
    },
    "data": {
        "m_user_id": "eric_test_02",
        "user_id": 10100016243,
        "merchant_id": 100034,
        "channel_id": 100034,
        "nickname": "eric_test_02",
        "status": 1,
        "create_time": 1749694365,
    },
    "microtime": 1749694521135
}

返回结构

参数 类型 备注
m_user_id 字符串 自定义用户编号(唯一)
user_id 整数 UID
merchant_id 整数 商户 ID
channel_id 整数 渠道 ID
nickname 字符串 用户昵称
status 整数 状态
create_time 整数 创建时间

获取 Token

HTTP请求:

获取某已经注册用户的身份标识符 Token,其他接口可以通过其进行鉴权

请求参数

参数 取值 必传 类型 备注
m_user_id uid2025061012492501 字符串 用户唯一标识符

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-21 15:18:15",
        "unique": "68565cb7018b81325099836",
        "runtime": "93.5 ms"
    },
    "data": {
        "token": "ceee2215737e93bcbdf44646e5bcb45fdbf199fa19cfcff4d93d6003758899137256e2480e6adc91dddf5e5f17",
        "user_id": 200028874,
        "m_user_id": "eric_test_2025062001",
        "channel_id": 100001,
        "login_time": 1750490295,
        "account_id": 200028874,
        "channel_product_id": 2003039,
        "token_exist_time": 2592000
    },
    "microtime": 1750490295099
}

返回结构

参数 类型 备注
m_user_id 字符串 自定义用户编号(唯一)
user_id 整数 UID
channel_id 整数 渠道 ID
token 字符串 Token 身份凭证
account_id 整数 账户 ID
channel_product_id 整数
token_exist_time 整数 Token 有效期
login_time 整数 登录时间

获取客户端签名配置

HTTP请求:

在服务端生成用户后,可以在客户端直接请求下面的具体业务接口,同样需要签名,签名需要的参数通过这个接口获取

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-21 15:25:29",
        "unique": "68565e6953378927475559",
        "runtime": "14.03 ms"
    },
    "data": {
        "channel_product_id": 2003039,
        "name": "will测试商户 商户API",
        "channel_id": 100001,
        "app_id": "aiENn1pvuSrRAOEJQtJ8rzUuT",
        "source": "MERCHANT_API",
        "status": 1,
        "client_secret": "xFXOleVXjwr9LpxWkQHxd5yOp3sfquX8iuDJXbWz6nLdXrEvQo1GuUBsJ8mH5NInaTzMQPv8WjwEwOBjTrLjkZxVq8BGYEzyVvHB"
    },
    "microtime": 1750490729355
}

返回结构

参数 类型 备注
channel_product_id 整数
name 字符串 名称
channel_id 整数 渠道 ID
app_id 整数 APP ID
source 整数 来源
status 整数 状态
client_secret 字符串 签名需要的标识符

开卡 - 客户端

[第一步].提交申请资料

用户申请开通某类型的卡片的第一步,提交申请材料

HTTP请求:

请求参数

参数 取值 必传 类型 备注
cvc_id 1 整数 卡类型ID
en_first_name Jack 字符串 英文的名字
en_last_name Ma 字符串 英文的姓
area 81 整数 电话的国际区号
mobile 8081 整数 电话
mobile_code 8056789876 整数 验证码
email test@gmail.com 字符串 邮箱
user_card_id 1 整数 用户卡 ID

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "user_card_id": 10009
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
user_card_id 整数 用户卡片 ID (池唯一标识)

UI 示例

提交开通材料


[第二步].提交快递信息

用户申请开通实体卡时,提交快递信息,在提交开通材料之后

这一步是可选的,如果是虚拟卡可以跳过

HTTP请求:

请求参数

参数 取值 必传 类型 备注
cvc_id 1 整数 卡类型ID
user_card_id 1 整数 用户卡 ID
full_name Jack 字符串 收件人姓名
area 81 整数 电话的国际区号
mobile 8081 整数 电话
email test@gmail.com 字符串 邮箱
country 中国 字符串 国家
state 江苏省 字符串 省/州
city 南京市 字符串 城市
address 玄武区玄武大道 100 号 字符串 详细地址
zip_code 232001 字符串 邮政编码

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "address_id": 22,
        "user_card_id": 10009,
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
address_id 整数 快递地址 ID (唯一标识)
user_card_id 整数 用户卡片 ID (池唯一标识)

UI 示例

提交快递信息


[第三步].提交 KYC 信息

提交用户的 KYC 认证信息

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 1 整数 用户卡 ID
email test@qq.com 字符串 邮箱
document_type 1 整数 证件类型:1/驾驶执照,2/护照,3/居民身份证,6/社会保障卡
document_code 31348976777 字符串 证件编码
country NL 字符串 发证国家
bron 1989.12.13 字符串 出生日期
provider 1 整数 KYC 认证机构:1/Sumsub,2/Myinfo,3/Jumio,4/Didit,5/Shufti
reference_id 693d20860b813fa74df74dfc 字符串 KYC 认证唯一标识符
address_country EG 字符串 居住国家
address_state abc 字符串 居住省/州
address_city abc 字符串 居住城市
address_street abc 字符串 居住街道
address_house_number abc 字符串 居住门牌号
address_post_code 232001 字符串 邮政编码
address_detail abc 字符串 居住详细地址

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "user_card_id": 10009,
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
user_card_id 整数 用户卡片 ID (池唯一标识)

[第四步].支付开卡费用

支付开卡费用,用户申请卡片流程的最后一步,支付成功后等待系统开卡就行了

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 1 整数 用户卡 ID

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "use_status": 1,
        "task_order_no": "TP928160611972902912"
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
use_status 整数 卡的状态(没有实际作用)
task_order_no 字符串 开卡任务编号(可以用来查询问题)

[第五步].激活

*支付完开卡费后,用户端的开卡流程就完成了,需要等待系统开卡,这是一个异步的过程,可以通过 myCards 接口查询最新状态,当开卡成功后再进行激活操作 *

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 1 整数 用户卡 ID
area 1 整数 手机国际区号
mobile 1 整数 手机号

手机号是非必须的,如果不传就会使用第一步提交开通材料里面的手机号

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "use_id": "123",
        "user_card_id": "1"
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
use_id 字符串 用户 UID
user_card_id 字符串 用户卡片 ID

开卡费用清单

获取用户申请的某张卡片的开卡费用清单,用于支付前的展示

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 1 整数 用户卡 ID

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "total_amount": "80.00",
        "open_card_fee": "60.00",
        "first_recharge_amount": "0.00",
        "open_card_deposit": "0.00",
        "shipment_fee": "20.00",
        "sub_amount": "0.00",
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
total_amount 字符串 总费用
open_card_fee 字符串 开卡费
first_recharge_amount 字符串 首充金额
open_card_deposit 字符串 开卡押金
shipment_fee 字符串 快递费
sub_amount 字符串 预付额度(附属卡)

UI 示例

开卡费清单


卡配置 - 客户端

已开通的卡列表

获取商户已经开通的卡片类型列表,返回卡片类型的基础信息

HTTP请求:

请求参数

参数 取值 必传 类型 备注

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-27 20:48:48",
        "unique": "685e9330d1033603006925",
        "runtime": "43.7 ms"
    },
    "data": [
        {
            "user_card_id": 4,
            "user_vip_level": 0,
            "cvc_id": 2,
            "use_status": -1,
            "vendor_card_id": 1000011,
            "release_type": 1,
            "use_type": 2,
            "balance_type": 2,
            "front_image": "http://static.aws-s1.com/admin/20250618232941/C9M641750260581.png",
            "logo": "http://static.aws-s1.com/admin/20250618142450/P57M71750227890.png",
            "is_kyc": 0,
            "is_email": 0,
            "is_bind_mobile": 1,
            "is_bind_email": 0,
            "open_card_status": 1,
            "recharge_status": 0,
            "vip_limit": 0,
            "is_apply": 1,
            "currency_id": 1,
            "currency_name": "USD",
            "max_spend_amount_single": "",
            "card_name_lang": "",
            "spend_fee_lang": "",
            "vendor_card_info": {
                "common": {
                    "release_type": 1,
                    "issue_vendor": "Visa",
                    "open_card_fee": "10.00",
                    "shipment_fee": "0.00",
                    "currency_id": 1,
                    "is_bind_mobile": 1,
                    "is_bind_email": 0,
                    "description": "",
                    "recharge_fee": "0.00",
                    "recharge_fee_rate": "0.00",
                    "max_spend_amount_single": "0.00",
                    "max_spend_amount_day": "0.00",
                    "spend_desc": ""
                },
                "spend": [

                ]
            },
            "user_card_info": {
                "balance": "0.00000000",
                "apply_id": 4,
                "address_id": 0,
                "apply_time": 1751010557,
                "is_sub_card": 0,
                "user_card_id": 4,
                "card_sales_type": 1
            },
            "sub_amount_list": [
                "5000",
                "10000",
                "15000",
                "20000",
                "50000",
                "100000"
            ],
            "fee": {
                "open_card_fee": "10.00000000",
                "add_open_card_fee": "0.00000000",
                "shipment_fee": "0.00000000",
                "year_fee": "",
                "replacement_fee": "0.00000000",
                "cancel_fee": "0.00000000",
                "first_recharge_amount": "0.00000000",
                "min_recharge_amount_single": "10.00000000",
                "max_recharge_amount_single": "100000.00000000",
                "max_spend_amount_single": "0.00000000",
                "max_spend_amount_day": "0.00000000",
                "recharge_fee_rate": "0.00000000",
                "add_recharge_fee_rate": "0.00000000",
                "spend_fee_rate": "0.00700000",
                "spend_fee": "0.00000000",
                "add_spend_fee_rate": "0.00000000",
                "add_spend_fee": "0.00000000",
                "cross_border_fee_rate": "0.00000000",
                "cross_border_fee": "0.00000000",
                "add_cross_border_fee_rate": "0.00000000",
                "add_cross_border_fee": "0.00000000"
            }
        }
    ],
    "microtime": 1751028528899
}

返回结构

参数 类型 备注
cvc_id 整数 卡配置 ID
user_card_id 整数 当前用户申请中的卡 ID
user_vip_level 整数 用户的 VIP 等级
use_status 整数 申请中的用户卡状态:-1 可以申请 1 不能申请
vendor_card_id 整数 卡商卡配置 ID
release_type 整数 卡类型:1/虚拟卡 2/实体卡
use_type 整数 卡类型:1/信用卡 2/储蓄卡
balance_type 整数 余额类型:1/充值卡 2/共享卡
front_image 字符串 卡面
logo 字符串 Logo
is_kyc 整数 当前用户是否已经 KYC 认证:0/否,1/是
is_bind_mobile 整数 是否需要绑定手机:0/否,1/是
is_bind_email 整数 是否需要绑定邮箱:0/否,1/是
open_card_status 整数 开卡状态:0/关闭,1/开启
recharge_status 整数 充值状态:0/关闭,1/开启
vip_limit 整数 VIP 限制等级
is_apply 整数 是否允许开卡: 0/否,1/是(根据用户的 VIP等级和VIP限制等级判断的)
currency_id 整数 卡的币种 ID
currency_name 字符串 卡的币种名称
max_spend_amount_single 字符串 单笔消费上限
card_name_lang 字符串 卡配置名称
spend_fee_lang 字符串 消费手续费
user_card_info.balance 字符串 当前用户申请中的卡:余额
user_card_info.apply_id 整数 当前用户申请中的卡:申请 ID
user_card_info.address_id 整数 当前用户申请中的卡:快递信息 ID
user_card_info.apply_time 整数 当前用户申请中的卡:申请时间
user_card_info.is_sub_card 整数 当前用户申请中的卡:是否是附属卡
user_card_info.user_card_id 整数 当前用户申请中的卡:卡片 ID
user_card_info.card_sales_type 整数 当前用户申请中的卡:来源
vendor_card_info.common.release_type 字符串 卡配置:卡类型:1/虚拟卡,2/实体卡
vendor_card_info.common.issue_vendor 字符串 卡配置:发行商
vendor_card_info.common.open_card_fee 字符串 卡配置:开卡费
vendor_card_info.common.shipment_fee 字符串 卡配置:快递费
vendor_card_info.common.currency_id 字符串 卡配置:币种 ID(法币)
vendor_card_info.common.description 字符串 卡配置:卡描述
vendor_card_info.common.recharge_fee 字符串 卡配置:固定的充值手续费
vendor_card_info.common.recharge_fee_rate 字符串 卡配置:百分比的充值手续费
vendor_card_info.common.max_spend_amount_single 字符串 卡配置:单笔消费限额
vendor_card_info.common.max_spend_amount_day 字符串 卡配置:每日消费额度
vendor_card_info.common.spend_desc 字符串 卡配置:消费描述
vendor_card_info.spend 对象 卡配置:消费方式
fee.open_card_fee 字符串 卡商的开卡费
fee.add_open_card_fee 字符串 商户的开卡费加点
fee.shipment_fee 字符串 邮寄费
fee.year_fee 字符串 年费
fee.replacement_fee 字符串 换卡费
fee.cancel_fee 字符串 注销费
fee.first_recharge_amount 字符串 首充值金额
fee.min_recharge_amount_single 字符串 最小充值金额 单笔
fee.max_recharge_amount_single 字符串 最大充值金额 单笔
fee.max_spend_amount_single 字符串 单笔消费限额
fee.max_spend_amount_day 字符串 单日消费限额
fee.recharge_fee_rate 字符串 百分比的充值手续费 - 卡商的
fee.add_recharge_fee_rate 字符串 百分比的充值手续费 - 商户加点
fee.spend_fee_rate 字符串 百分比的消费手续费 - 卡商的
fee.spend_fee 字符串 固定的消费手续费 - 卡商的
fee.add_spend_fee_rate 字符串 百分比的消费手续费 - 商户加点
fee.add_spend_fee 字符串 固定的消费手续费 - 商户加点
fee.cross_border_fee_rate 字符串 百分比的跨境手续费 - 卡商的
fee.cross_border_fee 字符串 固定的跨境手续费 - 卡商的
fee.add_cross_border_fee_rate 字符串 百分比的跨境手续费 - 商户加点
fee.add_cross_border_fee 字符串 固定的跨境手续费 - 商户加点

UI 示例

已开通的卡列表


用户卡片 - 客户端

我的卡片列表

获取用户的卡片列表,用于展示用户申请过的所有卡片记录

HTTP请求:

请求参数

参数 取值 必传 类型 备注

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:46",
        "unique": "68493a060997c1519682038",
        "runtime": "55.19 ms"
    },
    "data": [
        {
            "cvc_id": 1,
            "user_card_id": 66,
            "vendor_card_id": 10,
            "card_no": "**** **** **** 5996",
            "card_name": "USD 储蓄卡",
            "logo": "http://static.topcreditbank.com/admin/20250318181314/6QcZZ1742292794.png",
            "item_id": 10007,
            "front_image": "http://static.topcreditbank.com/admin/20250317204301/f0ykR1742215381.png",
            "card_currency_id": 1,
            "reason": "",
            "first_name": "fei",
            "last_name": "zhang",
            "parent_remark": "",
            "balance": "131.81",
            "credit_line": "1.00",
            "remaining_amount": "-10.91",
            "month_stats": {
                "total_amount": "0.00",
                "last_count": 0
            },
            "vendor_card_info": {
                "common": {
                    "release_type": 2,
                    "issue_vendor": "Visa",
                    "open_card_fee": "90.00",
                    "shipment_fee": "0.00",
                    "currency_id": 1,
                    "is_bind_mobile": 1,
                    "is_bind_email": 0,
                    "description": "高额度/ATM取现/通过率高",
                    "recharge_fee": "0.00",
                    "recharge_fee_rate": "0.02",
                    "max_spend_amount_single": "100000.00",
                    "max_spend_amount_day": "0.00",
                    "spend_desc": ""
                },
                "spend": [
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/axHKut1735805254565.png",
                        "title": "线下刷卡",
                        "desc": "MasterCard 进行刷卡支付"
                    },
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/nYToTn1735805254565.png",
                        "title": "取现",
                        "desc": "ATM 快速取现服务"
                    },
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/OUUjEi1735805254565.png",
                        "title": "支付工具",
                        "desc": "Alipay、Apple Pay 等支付绑定工具"
                    },
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/05Pkio1735805254565.png",
                        "title": "线上消费",
                        "desc": "抖音、亚马逊等主流消费平台"
                    }
                ]
            },
            "repay_info": {

            },
            "show_status": 2,
            "is_active": 1,
            "use_type": 2,
            "is_sub_card": 0,
            "card_sales_type": 3,
            "recharge_status": -1,
            "order": 40000066,
            "name": "USD 储蓄卡",
            "balance_type": 1,
            "max_spend_amount_single": "0.00000000",
            "max_spend_amount_day": "0.00000000",
            "is_sticky_top": 0
        },
        {
            "cvc_id": 1,
            "user_card_id": 1271,
            "vendor_card_id": 10,
            "card_no": "**** **** **** 4542",
            "card_name": "USD 储蓄卡",
            "logo": "http://static.topcreditbank.com/admin/20250318181314/6QcZZ1742292794.png",
            "item_id": 10007,
            "front_image": "http://static.topcreditbank.com/admin/20250317204301/f0ykR1742215381.png",
            "card_currency_id": 1,
            "reason": "",
            "first_name": "bei",
            "last_name": "liu",
            "parent_remark": "",
            "balance": "277.73",
            "credit_line": "0.00",
            "remaining_amount": "10.39",
            "month_stats": {
                "total_amount": "0.00",
                "last_count": 0
            },
            "vendor_card_info": {
                "common": {
                    "release_type": 2,
                    "issue_vendor": "Visa",
                    "open_card_fee": "90.00",
                    "shipment_fee": "0.00",
                    "currency_id": 1,
                    "is_bind_mobile": 1,
                    "is_bind_email": 0,
                    "description": "高额度/ATM取现/通过率高",
                    "recharge_fee": "0.00",
                    "recharge_fee_rate": "0.02",
                    "max_spend_amount_single": "100000.00",
                    "max_spend_amount_day": "0.00",
                    "spend_desc": ""
                },
                "spend": [
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/axHKut1735805254565.png",
                        "title": "线下刷卡",
                        "desc": "MasterCard 进行刷卡支付"
                    },
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/nYToTn1735805254565.png",
                        "title": "取现",
                        "desc": "ATM 快速取现服务"
                    },
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/OUUjEi1735805254565.png",
                        "title": "支付工具",
                        "desc": "Alipay、Apple Pay 等支付绑定工具"
                    },
                    {
                        "icon": "https://static.topcreditbank.com/upload/2025/0102/05Pkio1735805254565.png",
                        "title": "线上消费",
                        "desc": "抖音、亚马逊等主流消费平台"
                    }
                ]
            },
            "repay_info": {

            },
            "show_status": 5,
            "is_active": 1,
            "use_type": 2,
            "is_sub_card": 0,
            "card_sales_type": 1,
            "recharge_status": 1,
            "order": 1001271,
            "name": "USD 储蓄卡",
            "balance_type": 1,
            "max_spend_amount_single": "0.00000000",
            "max_spend_amount_day": "0.00000000",
            "is_sticky_top": 0
        }
    ],
    "microtime": 1749629446094
}

返回结构

参数 类型 备注
cvc_id 整数 卡配置 ID
user_card_id 整数 卡片 ID(唯一标识符)
vendor_card_id 整数 卡商卡片配置 ID
card_no 字符串 卡号(只展示后 4 位)
card_name 字符串 卡配置名称
logo 字符串 Logo(图片)
front_image 字符串 卡面(图片)
item_id 整数 可授信额度的币种 ID:USDT
reason 字符串 开卡失败的原因
first_name 字符串 持卡人的名字(提交开通材料的时候填写)
last_name 字符串 持卡人的姓 (提交开通材料的时候填写)
balance 字符串 卡的余额(储蓄卡才有)
credit_line 字符串 卡的授信额度(信用卡才有)
remaining_amount 字符串 剩余还款金额 (信用卡才有)
show_status 整数 状态 :1/待绑定,2/激活中,3/激活失败,4/已锁卡,5/正常使用,6/激活中,7/待激活
is_active 整数 是否激活:0/否,1/是
use_type 整数 卡片类型:1 - 信用卡, 2 - 储蓄卡
is_sub_card 整数 是否是附属卡:0/否,1/是
card_sales_type 整数 卡的来源:
recharge_status 整数 充值状态:-1/不可充值,0/关闭充值/,1/开启充值
order 整数 排序值
name 字符串 卡片的名称,如果没有自定义会和 card_name 一样
balance_type 整数 余额类型:1/充值卡,2/共享卡
max_spend_amount_single 字符串 单次消费额度
max_spend_amount_day 字符串 每日消费额度
is_sticky_top 整数 是否置顶 :0/否,1/是
month_stats.total_amount 字符串 近 30 天的消费金额
month_stats.last_count 整数 近 30 天的消费数量
repay_info.repaid_amount 字符串 待还款金额
repay_info.remaining_amount 字符串 剩余额度
repay_info.auto_repay_date 字符串 还款日期
repay_info.repay_date 字符串 还款日期
vendor_card_info.common.release_type 字符串 卡配置:卡类型:1/虚拟卡,2/实体卡
vendor_card_info.common.issue_vendor 字符串 卡配置:发行商
vendor_card_info.common.open_card_fee 字符串 卡配置:开卡费
vendor_card_info.common.shipment_fee 字符串 卡配置:快递费
vendor_card_info.common.currency_id 字符串 卡配置:币种 ID(法币)
vendor_card_info.common.description 字符串 卡配置:卡描述
vendor_card_info.common.recharge_fee 字符串 卡配置:固定的充值手续费
vendor_card_info.common.recharge_fee_rate 字符串 卡配置:百分比的充值手续费
vendor_card_info.common.max_spend_amount_single 字符串 卡配置:单笔消费限额
vendor_card_info.common.max_spend_amount_day 字符串 卡配置:每日消费额度
vendor_card_info.common.spend_desc 字符串 卡配置:消费描述
vendor_card_info.spend 对象 卡配置:消费方式

UI 示例

我的卡列表 激活中的卡片 申请成功的卡片


我的卡片详情

获取用户的卡片详情,包括了卡的敏感信息:cvv/完整卡号/过期时间

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 2 整形

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:46",
        "unique": "68493a060997c1519682038",
        "runtime": "55.19 ms"
    },
    "data": {
        "card_merchant": "Visa",
        "issue_vendor": "Visa",
        "first_name": "eric",
        "last_name": "wang",
        "card_number": "1234 4567 8900 2345",
        "card_no": "1234 4567 8900 2345",
        "expire": "12/2030",
        "cvv": "234",
        "area": "81",
        "mobile": "12345678",
        "email": "test@gmail.com",
        "max_spend_amount_single": "10,000.00",
        "max_spend_amount_day": "10,000.00",
        "name": "Test Card",
        "balance_type": 2
    },
    "microtime": 1749629446094
}

返回结构

参数 类型 备注
card_merchant 字符串 卡的发行商
issue_vendor 字符串 卡的发行商
first_name 字符串 英文名
last_name 字符串 英文姓
card_number 字符串 完整卡号
card_no 字符串 完整卡号
expire 字符串 卡的有效期
cvv 整型 CVV
area 整型 国际区号
mobile 整型 手机号
email 字符串 邮箱
max_spend_amount_single 字符串 单笔消费限额
max_spend_amount_day 字符串 单日消费限额
name 字符串 卡的备注(名称)
balance_type 字符串 卡的余额类型:1/充值卡 2/共享卡

卡的账单列表

获取某张卡片的账单列表数据

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 1 整数 用户卡 ID (我的卡列表中返回)
record_type 1 整数 自定义类型 ID(枚举值见返回结构)
user_bill_id 1 整数 账单 ID (如果传了相当于详情接口)
start_time 1741166648 整数 开始时间戳
end_time 1742585523 整数 结束时间戳
page 1 整数 第几页
page_size 15 整数 当前页数量

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "list": [
            {
                "fee": "1.36",
                "amount": "12.00",
                "post_time": 1743062645,
                "tx_amount": "-12.00",
                "direction": 1,
                "status": 1,
                "type_name": "抵押",
                "type": 2,
                "bill_type": 2,
                "trade_time": 1743062645,
                "tx_item_id": 10007,
                "currency_id": "USD",
                "create_time": 1743062645,
                "description": " Topcredit 金融卡",
                "org_trade_time": 1743062778,
                "card_number_end": "4542",
                "vendor_order_no": "RC1218766968962031616",
                "repay_amount": 0,
                "remain_amount": 0,
                "currency_amount": "10.64",
                "exchange_rate": "0.8866",
                "user_bill_id": 16771,
                "user_card_id": 1271
            }
        ],
        "pageInfo": {
            "pageCurrent": 1,
            "pageCount": 1,
            "pageSize": 10,
            "pageTotal": 2
        },
        "statistics": {
            "currency_id": 1,
            "last_count_total": 0,
            "last_amount_total": "0.00"
        }
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
user_bill_id 整数 账单 ID(唯一标识符)
user_card_id 整数 卡片 ID
fee 字符串 手续费 (USDT)
amount 字符串 账单金额(包含手续费 USDT)
tx_amount 整数 交易结算金额 (充值类型 - USDT,消费类型 - 卡币种)
direction 整数 资金方向(1/流入 -1/流出,可以根据这个字段在金额前面显示 +/-)
status 整数 状态 :1/成功,2/取消,3/处理中,4/失败
type_name 字符串 卡商交易类型名称
type 整数 卡商交易类型 :1/消费,2/充值,3/取款,4/转账 - 转入,5/转账 - 转出,6/其他,7/结算调整,8/退款,9/受权查询,10/冲正,11/交易处理费,12/还款,13/上一期结余未还,14/开卡费,15/快递费用,16/开卡押金
bill_type 整数 自定义交易类型:1/消费,2/充值,3/退款,4/其他,5/开卡/快递,6/还款
trade_time 整数 交易时间
tx_item_id 整数 交易结算币种 ID
currency_id 整数 消费的法币ID / 充值卡到帐法币ID
create_time 整数 账单的创建时间(入账时间)
description 字符串 交易商户
org_trade_time 整数 卡商的交易完成时间
card_number_end 字符串 卡片的后 4 位
vendor_order_no 字符串 卡商订单号
repay_amount 字符串 已还款金额
remain_amount 字符串 剩余需要还款金额(法币)
currency_amount 字符串 消费金额 / 充值卡到帐金额法币 (法币)
exchange_rate 字符串 汇率

UI 示例

账单详情列表


账单详情

获取账单的详细数据,用于单个账单的展示

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_bill_id 1 整数 账单 ID

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:28",
        "unique": "684939f470ad1271203539",
        "runtime": "40.96 ms"
    },
    "data": {
        "fee": "1.36",
        "amount": "12.00",
        "post_time": 1743062645,
        "tx_amount": "-12.00",
        "direction": 1,
        "status": 1,
        "type_name": "抵押",
        "type": 2,
        "bill_type": 2,
        "trade_time": 1743062645,
        "tx_item_id": 10007,
        "currency_id": "USD",
        "create_time": 1743062645,
        "description": " Topcredit 金融卡",
        "org_trade_time": 1743062778,
        "card_number_end": "4542",
        "vendor_order_no": "RC1218766968962031616",
        "repay_amount": 0,
        "remain_amount": 0,
        "currency_amount": "10.64",
        "exchange_rate": "0.8866",
        "user_bill_id": 16771,
        "user_card_id": 1271
    },
    "microtime": 1749629428502
}

返回结构

参数 类型 备注
user_bill_id 整数 账单 ID(唯一标识符)
user_card_id 整数 卡片 ID
fee 字符串 手续费 (USDT)
amount 字符串 账单金额(包含手续费 USDT)
tx_amount 整数 交易结算金额 (充值类型 - USDT,消费类型 - 卡币种)
direction 整数 资金方向(1/流入 -1/流出,可以根据这个字段在金额前面显示 +/-)
status 整数 状态 :1/成功,2/取消,3/处理中,4/失败
type_name 字符串 卡商交易类型名称
type 整数 卡商交易类型 :1/消费,2/充值,3/取款,4/转账 - 转入,5/转账 - 转出,6/其他,7/结算调整,8/退款,9/受权查询,10/冲正,11/交易处理费,12/还款,13/上一期结余未还,14/开卡费,15/快递费用,16/开卡押金
bill_type 整数 自定义交易类型:1/消费,2/充值,3/退款,4/其他,5/开卡/快递,6/还款
trade_time 整数 交易时间
tx_item_id 整数 交易结算币种 ID
currency_id 整数 消费的法币ID / 充值卡到帐法币ID
create_time 整数 账单的创建时间(入账时间)
description 字符串 交易商户
org_trade_time 整数 卡商的交易完成时间
card_number_end 字符串 卡片的后 4 位
vendor_order_no 字符串 卡商订单号
repay_amount 字符串 已还款金额
remain_amount 字符串 剩余需要还款金额(法币)
currency_amount 字符串 消费金额 / 充值卡到帐金额法币 (法币)
exchange_rate 字符串 汇率

UI 示例

账单详情 - 抵押 账单详情 - 消费


锁卡

锁定卡片,卡片锁定后不能消费

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 2 整形

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:46",
        "unique": "68493a060997c1519682038",
        "runtime": "55.19 ms"
    },
    "data": {
        "user_card_id": 2
    },
    "microtime": 1749629446094
}

返回结构

参数 类型 备注
user_card_id 整型 用户卡片 ID

解锁卡

解锁卡卡片

HTTP请求:

请求参数

参数 取值 必传 类型 备注
user_card_id 2 整形

响应

{
    "status": 200,
    "msg": "ok",
    "extend": {
        "date": "2025-06-11 16:10:46",
        "unique": "68493a060997c1519682038",
        "runtime": "55.19 ms"
    },
    "data": {
        "user_card_id": 2
    },
    "microtime": 1749629446094
}

返回结构

参数 类型 备注
user_card_id 整型 用户卡片 ID