Qbit Developer

模型

Account 模型

Account 储存客户账户的基础信息，如 KYC 的状态等。它是代表客户账户的最基础 model，跟大多数其他 models 的关联关系都通过 Account 的 Id 来实现。

字段 类型 可能的值 说明
id string 账户 id
createTime Date 创建时间
type string MasterAccount/SubAccount 账户类型
status string Active/Frozen/Inactive 状态
name string 企业名
displayId string 分配的唯一数字 ID
kycStatus string Pending/Request/Passed/Canceled/Na kyc 状态
cardKybStatus string Pending/Request/Passed/Canceled/Na 量子卡业务 kyb 状态
globalAccountKybStatus string Pending/Request/Passed/Canceled/Na 全球账户业务 kyb 状态

status可能的值为:

  • Active(正常激活)
  • Frozen(冻结，只能查看不能操作)
  • Inactive(暂时关停，任何操作都不能进行)

kycStatus、cardKybStatus、globalAccountKybStatus 可能的值为:

  • Pending(提交但未审核)
  • Request(待补录、驳回)
  • Passed(审核通过)
  • Canceled(取消准入)
  • Na(未提交)

type 可能的值为:

  • MasterAccount(主体账户)
  • SubAccount(子账户)

User 模型

每一个账户下可以有一个或者多个登录用户User，且设置相应的系统操作权限。在创建Account后，会自动创建第一个User ，默认为管理员的权限。账户的登录信息存储在Usermodel 中。

字段 类型 可能的值 说明
id string 账户 id
createTime Date 创建时间
status string Active/Frozen/Inactive 状态
phone string phone
email string email
name string 操作员名称

status可能的值为:

  • Active(正常激活)
  • Frozen(冻结，只能查看不能操作)
  • Inactive(暂时关停，任何操作都不能进行)

Address 模型

在一些 API 中会使用到地址对象，这是一个通用地址格式

字段 类型 说明
addressLine1 string 详细地址 1
addressLine2 string 详细地址 2
city string 城市
state string 街道
country string 国家
postalCode string 邮政编码

Balance 模型

Balance 是所有账户在 Qbit 系统内金额，多种业务、多种币种会有不同的钱包

字段 类型 可能的值 说明
id string 钱包 id
accountId string 客户 Id
createTime Date 创建时间
available number 可用余额
pending number 处理中余额
frozen number 冻结的余额
currency string 币种
walletType string QbitCard/QbitAccount/GlobalAccount/CryptoAsset 余额类型

walletType可能的值为:

  • QbitCard(量子卡)
  • QbitAccount(量子账户)
  • QbitBudget(预算)
  • GlobalAccount(全球账户)

KYC 模型

字段 类型 是否为必填 说明
accountId string 是 账户 ID
address json 是 地址
addressEn json 是 英文地址
name json 是 姓名
dob string 是 生日(如 1996-11-24)
nationality string 是 国家代码(如 CN)
identification json 是 证件
workInfo json 是 职业信息
status string 是 状态
message string 是 驳回、拒绝原因
attachments string[] 是 附件 ID 数组, 驳回、拒绝原因附件

status可能的值为:

  • Pending(提交后尚未审核)
  • Passed(通过)
  • Request(驳回，需要需要重新提交 KYC)
  • Canceled(拒绝,需要重新提交 KYC + 人脸识别)

CddName 模型

字段 类型 说明
firstName string 名：类举：林峰
firstNameEn string 名英文(可为空)：类举：Auspicious
firstNamePinYin string 名拼音：类举：LinFeng
lastName string 姓：类举：侯
lastNameEn string 姓英文(可为空)：类举：Monkey
lastNamePinYin string 姓拼音：类举：Hou

Identification 模型

证件信息

字段 类型 可能的值 说明
frontAttachmentId string 身份证正面附件 id
backAttachmentId string 身份证反面面附件 id
number string 证件号
startDate string 证件有效期(起始时间)
expirationDate string 证件有效期(过期日期 )

量子卡

Budget 模型

预算信息

字段 类型 可能的值 说明
id string id
accountId string 客户 id
name string 预算名称
balanceId string 钱包 id
expiryDate Date 预算有效期
createTime Date 创建时间
status string Active/Frozen/Inactive 预算状态

CardBin 模型

卡bin信息

字段 类型 可能的值 说明
bin string 银行识别码 (BIN)，卡的前 6 位数字
type string 卡类型
PrepaidCard (储值卡)
BudgetCard (额度卡)
ipr boolean 量子优选卡
network string 卡的网络(VISA, MasterCard)
issuerCountry string 发行银行的国家代码。遵循 ISO 3166-1 alpha-2 (opens new window) 标准
verification object 验证信息
verification.avs boolean 是否支持 AVS 检查
verification.threeDs boolean 是否支持3DS验证
purchaseLimit object 消费限额
purchaseLimit.day string 单日消费限额(/表示不限制)
purchaseLimit.single string 单笔消费限额(/表示不限制)
purchaseLimit.lifetime string 生命周期限额(/表示不限制)
使用期间的总消费限额

Card 模型

量子卡信息，基础的一些卡后四位、状态以及非私密的一些信息。

字段 类型 可能的值 说明
id string id
accountId string 客户 Id
createTime Date 创建时间
userName string 卡的用户名称
currency string 币种
provider string 卡头
status string Active/Frozen/Inactive 卡状态
qbitCardNoLastFour string 卡号后 4 位
token string 卡的唯一三方识别 id
label string 标签
cardAddress json 卡地址
balanceId string 钱包余额
budgetId string 预算 id(卡没绑定预算时该字段为 null)

status可能的值为:

  • Active(正常激活)
  • Frozen(冻结)
  • Inactive(删除)
  • Control(合规管控)

provider可能的值为:

  • PrepaidCard_493193 (493193 卡段储值卡)
  • PrepaidCard_428837 (428837 卡段储值卡)
  • PrepaidCard_540524 (540524 卡段储值卡)
  • PrepaidCard_222929 (222929 卡段储值卡)
  • PrepaidCard_414631 (414631 卡段储值卡)
  • PrepaidCard_493728 (493728 卡段储值卡)
  • BudgetCard_493193 (493193 卡段额度卡)
  • BudgetCard_222929 (222929 卡段额度卡)
  • BudgetCard_414631 (414631 卡段额度卡)
  • BudgetCard_493728 (493728 卡段额度卡)

CardReceiver 模型

量子卡收款人信息，只用于量子用户提现使用。

字段 类型 可能的值 说明
id string 收款方 id
status string Pending/Request/Passed/Canceled/Inactive 状态
currency string 值过多，详情请看currency可能的值 币种
accountType string Business/Individual 账户类型(企业或者个人)
userName string 收款方名称
accountNumber string 收款方银行账户
receiverAddress json 值过多，详情请看Address可能的值 收款是个人地址、公司地址
bankName string 银行名称
bankAddress json 值过多，详情请看Address可能的值 银行地址
bankBranchName string 银行支行名称
certificateNo string 个人证件号、企业统一社会信用代码
routingType string 值过多，详情请看routingType可能的值 Routing type
routingNumber string Routing number
bic string bic_swift
iban string iban

CardTransaction 模型

量子卡交易信息，量子卡的转入、转出、消费、退款等。

字段 类型 可能的值 说明
id string
交易 ID
accountId string 账户 ID
cardId string 量子卡 ID
currency string 币种
amount number 交易金额
fee number 手续费
clientTransactionId string client 交易 ID(方便关联订单)
type string 交易类型
status string Pending/Closed/Fail 交易状态
transactionTime Date 交易时间
detail string 交易详情
remark string 交易备注
relationTransactionId string Reversal订单关联的原交易ID

status可能的值为:

  • Pending(处理中)
  • Closed(已完成)
  • Fail(失败)

type可能的值为:

  • Consumption(消费)
  • TransferIn(转入)
  • TransferOut(转出)
  • Credit(退款)
  • Frozen(冻结卡金额)
  • UnFrozen(解冻卡金额)
  • Reversal(反转)

BudgetTransaction 模型

预算交易信息，预算的转入、转出、消费、退款等。

字段 类型 可能的值 说明
id string
交易 ID
accountId string 账户 ID
budgetId string 预算 ID
cardId string 卡 id
amount number 交易金额
fee number 手续费
clientTransactionId string client 交易 ID(方便关联订单)
type string 交易类型
status string Pending/Closed/Fail 交易状态
transactionTime Date 交易时间
detail string 交易详情

type可能的值为:

  • Consumption(消费)
  • TransferIn(转入)
  • TransferOut(转出)
  • Credit(退款)
  • CreateCardFee(开卡 fee)

CardOtp 模型

基于 OTP 的 3DS 身份验证。

字段 类型 可能的值 说明
cardId string 量子卡 ID
accountId string 账户 ID
currency string 交易币种
amount number 交易金额
cardNumber string 卡号(前六后四)
otp string 交易的 3DS OTP

全球账户

GlobalSubAccount 模型

全球账户子账户信息

字段 类型 可能的值 说明
id string id
accountId string 客户 Id
createTime Date 创建时间
nickname string 全球账户昵称
purpose string 全球账户用途
currency string 全球账户币种
balanceId string 全球账户钱包 ID （用于付款）

BankAccounts 模型

银行账户信息

字段 类型 可能的值 说明
id string id
accountId string 客户 Id
createTime Date 创建时间
accountName string 账户持有人姓名
accountNo string 账号
currency string 币种
bankName string 银行名称
bankAddress string 银行地址
swift string SWIFT/BIC
routingNumber string Routing number
routingType string Routing type
branchName string 支行名称
branchCode string 支行代码
status string Active/Frozen/Inactive 状态

status可能的值为:

  • Active(正常激活)
  • Frozen(冻结)
  • Inactive(删除)

Beneficiary 模型

全球账户受益人信息

字段 类型 可能的值 说明
id string 收款方 id
accountId string 客户 Id
currency string 值过多，详情请看currency可能的值 币种
type string Business/Individual 账户类型(企业或者个人)
userName string 收款方名称
accountNumber string 收款方银行账户
relationship enum 值过多，详情请看relationship可能的值 收款方与此账户关系
receiverAddress json 值过多，详情请看Address可能的值 收款是个人地址、公司地址
bankName string 银行名称
bankAddress json 值过多，详情请看Address可能的值 银行地址
bankBranchName string 银行支行名称
certificateNo string 个人证件号、企业统一社会信用代码
routingType string 值过多，详情请看routingType可能的值 Routing type
routingNumber string Routing number
bic string bic_swift
iban string iban

currency可能的值为：

  • USD
  • CNY
  • EUR
  • GBP
  • AUD
  • CAD
  • CZK
  • DKK
  • HKD
  • HRK
  • HUF
  • IDR
  • INR
  • MXN
  • MYR
  • NOK
  • PHP
  • PLN
  • SEK
  • SGD
  • RON

Relationship可能的值为：

  • SAME_ACCOUNT (同名账户)
  • CHANNEL_CHECK (渠道验证)
  • NOT_SAME_ACCOUNT (非同名账户)
  • E_COMMERCE_PLATFORM = (电商平台/独立站收款)
  • OTHER_CHANNELS = (其他渠道/机构加款)
  • ASSOCIATED_SUBJECT (关联主体)
  • TRADE_RELATIONS (贸易关系)
  • AGENCY_RELATIONSHIP (代理关系、供销关系关联公司)
  • SAME_SUBJECT (同名主体)

accountType可能的值为:

  • Individual(对私账户)
  • Business(对公账户)

routingType可能的值为:

  • sort_code
  • aba
  • bsb_code
  • institution_no
  • bank_code
  • branch_code
  • clabe
  • cnaps
  • ifsc
  • RON

transferType可能的值为:

  • Local(本地，使用本地网络付款)
  • International(国际, 使用 SWIFT 网络付款)
  • Settle(结汇下发，收款人银行账户币种为 CNY)

receiverType可能的值为:

  • QBit(Qbit 系统内部转账账户)
  • Bank(正常银行账户)

GlobalAccountTransaction 模型

全球账户交易信息

字段 类型 可能的值 说明
id string 交易 id
accountId string 账户 ID
createTime Date 创建时间
transactionTime Date 交易时间(随着订单状态更新)
currency string 值过多，详情请看currency可能的值 币种
settlementCurrency string 值过多，详情请看currency可能的值 实际收款币种
counterparty string 对手方名称
transactionAmount number 交易金额
fee number 手续费
businessType string Inbound/Outbound 业务类型
status string Pending/Closed/Fail 交易状态
clientTransactionId string 系统编号(方便 Client 关联订单）
transactionId string 订单编号

status可能的值为:

  • Pending(处理中)
  • Closed(已完成)
  • Fail(失败)

type可能的值为:

  • Payment(付款)
  • TransferIn(转入)
  • TransferOut(转出)
  • Refunds(退款)
  • Fee(手续费)
  • InnerTransferOut(内部转出)
  • InnerTransferIn(内部转入)

信用卡收单

Verification 对象

字段 类型 可能的值 说明
cvv string cvv 验证
avs string 地址验证

Card 卡模型

卡信息

字段 类型 可能的值 说明
id string id
firstName string 持卡人-first name
lastName string 持卡人-last name
expMonth number 卡有效期-月
expYear number 卡有效期-年
bin string 卡号-前六
last4 string 卡号-后四
email string 持卡人邮箱
verification Verification 验证信息
createTime date 创建时间
updateTime date 更新时间

Payment 卡交易模型

卡交易信息

字段 类型 可能的值 说明
id string id
accountId string 客户 id
cardId string 卡 id
memo string 备注
currency string 币种
amount number 付款金额
fee number fee
type string 交易类型
createTime date 创建时间
updateTime date 更新时间
status string 预算状态

WebHook 推送

Notification 模型

WebHook 通知信息

字段 类型 可能的值 说明
id string id
accountId string 账户 Id
createTime Date 创建时间
businessType string 值过多，详情请看businessType可能的值 业务类型
businessStatus string Pending/Processing/Request/Success/Fail 业务状态
data json 消息内容
sign string 签名（签名详情）, 只有 data 字段的数据参与签名
remark string 备注
notificationStatus string 消息状态

businessType可能的值为:

  • AccountRegistered(账户注册)
  • KYC(KYC)
  • QbitCardKyb(量子卡 KYB)
  • GlobalAccountKyb(全球账户 KYB)
  • CreateGlobalAccount(合规开通全球)
  • BankAccountTransaction(全球账户交易)
  • CreateCard(创建量子卡)
  • FrozenCard(冻结量子卡)
  • UnfrozenCard(解冻量子卡),
  • DeleteCard(删除量子卡)
  • CardStateChange(量子卡状态变更)
  • CardTransaction(卡交易)
  • FrozenAmount(冻结量子卡金额)
  • UnfrozenAmount(解冻量子卡金额)
  • Card3dsOtp(基于 OTP 的 3DS 身份验证)

businessStatus可能的值为:

  • Pending(已提交，但未处理)
  • Processing(处理中)
  • Request(待完善)
  • Success(成功)
  • Fail(失败)

data 的值在不同业务类型下，返回的值也不一样

  • 当 businessType 为 AccountRegistered 时，data 返回：Account
  • 当 businessType 为 KYC 时，data 返回：data 返回：Account
  • 当 businessType 为 QbitCardKyb/GlobalAccountKyb 时，data 返回：Account
  • 当 businessType 为 CreateGlobalAccount 时，data 返回 BankAccount（会对账户号做隐私保护，只显示后几位）
  • 当 businessType 为 GlobalAccountTransaction 成功时，data 返回 GlobalAccountTransaction
  • 当 businessType 为 CreateCard 成功时，data 返回 Card
  • 当 businessType 为 FrozenCard 成功时，data 返回 Card
  • 当 businessType 为 UnfrozenCard 成功时，data 返回 Card
  • 当 businessType 为 DeleteCard 成功时，data 返回 Card
  • 当 businessType 为 CardStateChange 成功时，data 返回 Card
  • 当 businessType 为 CardTransaction 成功时，返回 data 返回 CardTransaction
  • 当 businessType 为 FrozenAmount 成功时，返回 data 返回 CardTransaction
  • 当 businessType 为 UnfrozenAmount 成功时，返回 data 返回 CardTransaction
  • 当 businessType 为 BudgetTransaction 成功时，返回 data 返回 BudgetTransaction
  • 当 businessType 为 Card3dsOtp 成功时，返回 data 返回 CardOtp

← 通用 API →