Qbit API 资源

核心资源

Account 对象

示例

{
  "id": "cae9efe2-b577-4632-8c57-8822ddb8542a",
  "type": "SubAccount",
  "status": "Active",
  "name": "wangwu0213",
  "displayId": "251759",
  "kycStatus": "Na",
  "cardKybStatus": "Passed",
  "createTime": "2023-03-06T07:51:59.391Z"
}

Account 属性

id string

账户ID

type string

账户类型可能的值: SubAccount, MasterAccount.

status string

账户状态可能的值: Active, Frozen, Inactive.

name string

账户名

displayId string

分配的唯一ID

kycStatus string

账户KYC状态可能的值: Pending, Request, Passed, Canceled, Na.

qbitCardKybStatus string

量子卡KYB状态可能的值: Pending, Request, Passed, Canceled, Na.

message string

KYC拒绝原因

createTime string
创建时间

User 对象

示例

{
  "id": "7d09c531-dd0b-4027-aa65-4e6f63416fae",
  "createTime": "2023-03-07T07:09:45.949Z",
  "status": "Active",
  "phone": "+8619923338445",
  "email": null,
  "name": "Macey.Mosciski科技有限公司"
}

User 属性

id string

用户ID

status string

用户状态可能的值: Active, Frozen, Inactive.

phone string

手机号(包含区号)

email string

邮箱

name string

用户名

createTime string

创建时间

FaceAuthentication 对象

示例

{
    "accountId": "38bd10c0-ac62-4bd3-93cc-b189e260d31d",
    "status": "Na",
    "reason": ""
}

FaceAuthentication 属性

accountId string

账户ID

status string

人脸认证状态可能的值: Na, Pending, Success, Fail.

reason string

人脸认证失败的原因

Balance 对象

示例

{
    "id": "5abd4512-073f-43a0-a6e9-8378464f4e2f",
    "accountId": "c110e2aa-322b-4f3f-a795-f441955844ed",
    "available": 100,
    "pending": 50,
    "frozen": 0,
    "currency": "USD",
    "createTime": "2021-07-14T09:27:39.174Z",
    "walletType": "Card"
}

Balance 属性

id string

余额ID

accountId string

账户ID

available double

可用余额

frozen double

冻结余额

walletType string

余额类型可能的值: QbitCard, QbitBudget, QbitAccount, GlobalAccount.

createTime string

创建时间

量子卡资源

Budget 对象

示例

{
    "id": "08971715-b7b4-4916-ad98-c1719ea2035f",
    "accountId": "88c5610d-2bb3-4a8e-a506-9e00f69bae37",
    "name": "Kole.Little",
    "balanceId": "46ed0562-48d9-4460-b534-b3c35e96bedc",
    "expiryDate": "2099-12-31T15:59:59.000Z",
    "status": "Active",
    "createTime": "2022-01-18T03:08:56.779Z"
}

Budget 属性

id string

预算ID

accountId string

账户ID

name string

预算名

balanceId string

余额ID

expiryDate string

预算有效期

status string

预算状态可能的值: Active, Frozen, Inactive.

createTime string

创建时间

Card 对象

示例

{
    "id": "ce04331f-d2f3-42de-8d65-f66c69aa3888",
    "accountId": "e8b0d02e-5f70-4baa-b824-b4f87e34716d",
    "token": "3d9bbdf1-3c93-4fbe-80bc-a3bfe25bd6ce",
    "status": "Inactive",
    "currency": "USD",
    "provider": "PrepaidCard_493193",
    "userName": "as aa",
    "createTime": "2021-08-30T11:59:32.935Z",
    "cardNoLastFour": "9990",
    "cardAddress": null,
    "label": "默认",
    "balanceId": "7eddcfcc-f6a3-4875-8aab-2c7a0f639023"
}

Card 属性

id string

卡ID

accountId string

账户ID

status string

卡状态可能的值: Active, Inactive, Frozen, Control.

balanceId string

余额ID

budgetId string

预算ID

token string

三方唯一的卡标识

currencystring

币种

provider string

卡提供方(type + bin)

userName string

持卡人

cardNoLastFour string

卡号后四位

label string

自定义label

createTime string

创建时间

CardTransaction 对象

示例

{
    "id": "302b17cf-b56a-4f86-bc7f-32ae6dd71550",
    "accountId": "2040791b-9132-4621-86a7-3e5476db9dab",
    "cardId": "de61fa0f-c6b2-4dfe-b411-873fd43fbd51",
    "currency": "USD",
    "amount": 10,
    "fee": 0,
    "type": "TransferIn",
    "clientTransactionId": "595f83f6-9b28-464d-be77-e9e7319d2951",
    "status": "Closed",
    "transactionTime": "2021-10-28T11:07:31.019Z"
}

CardTransaction 属性

id string

交易ID

accountId string

账户ID

cardId string

卡ID

currencystring

交易币种

amount double

交易金额

fee double

交易手续费

type string

交易类型可能的值: Consumption, TransferIn, TransferOut, Credit, Reversal, Fee_Consumption, Declined_Fee.

clientTransactionId string

客户端自定义交易ID

status string

交易状态可能的值: Pending, Closed, Fail.

transactionTime string

交易时间

BudgetTransaction 对象

示例

{
    "id": "b4e61edc-63d0-44b9-9251-d1b10fcfb4bb",
    "accountId": "88c5610d-2bb3-4a8e-a506-9e00f69bae37",
    "budgetId": "00f0012e-ce96-4135-8cf8-e6eb51463040",
    "cardId": null,
    "amount": 0.11,
    "fee": 0,
    "type": "TransferIn",
    "clientTransactionId": "5dce475f-4950-4961-9977-0dad80d318e4",
    "status": "Closed",
    "transactionTime": "2022-01-19T08:44:38.599Z"
}

BudgetTransaction 属性

id string

交易ID

accountId string

账户ID

budgetId string

预算ID

cardId string

卡ID

currencystring

币种

amount double

交易金额

fee double

交易手续费

type string

交易类型可能的值: Consumption, TransferIn, TransferOut, Credit, Reversal, CreateCardFee.

clientTransactionId string

客户端自定义交易ID

status string

交易状态可能的值: Pending, Closed, Fail.

transactionTime string

交易时间

Cardholder

示例

{
  "bin": "454924",
  "firstName": "san",
  "lastName": "zhang",
  "email": "[email protected]"
}

Cardholder 属性

status string

状态

Active：开户审核完成的状态（可以开卡）；
Pending：银行资料审核中（不能开卡）；
Inactive：银行拒绝了此开户资料（不能开卡）；

firstName string

名

lastName string

姓

userName string

用户名

idstring

持卡人id

全球账户资源

BankAccount 对象

示例

{
    "id": "f3f1855d-0942-4e9c-bbf8-e97db721103e",
    "status": "Active",
    "currency": "USD",
    "accountNo": "GB49TCCL12345614818413",
    "accountId": "d37deed7-f0e7-4635-a43a-781af0cb59f0",
    "createTime": "2023-02-24T03:29:42.241Z",
    "bankName": "The Currency Cloud Limited",
    "routingType": "BIC_SWIFT",
    "routingNumber": "TCCLGB3L",
    "bankAddress": "12 Steward Street, The Steward Building, London, E1 6FQ, GB",
    "accountName": "API TEST"
}

全球账户属性

id string

银行账户ID

accountId string

账户ID

accountName string

账户持有人姓名

accountNo string

帐号

currency string

币种

bankName string

银行名

bankAddress string

银行地址

swift string

SWIFT/BIC

routingNumber string

汇款路线号码

routingType string

汇款路线类型

branchName string

支行名称

branchCode string

支行代码

status string

状态可能的值: Active, Frozen, Inactive.

createTime string

创建时间

GlobalAccountTransaction 对象

示例

{
    "id": "2e3cbb16-a420-4080-9094-e19f45371fee",
    "code": null,
    "codeMessage": null,
    "accountId": "285fd3d0-d8d1-4b42-91ba-31ca6c100639",
    "counterparty": "USD-US-25-Swift",
    "amount": "120",
    "transactionDisplayId": "2502241017134475",
    "businessType": "PAYMENT",
    "status": null,
    "payeeId": null,
    "reference": "memo",
    "memo": null,
    "balanceId": "d4d1b32c-6b72-466e-9b30-c595c0095c32",
    "currency": "USD",
    "clientTransactionId": "f2388319-1116-4769-9a41-c60b96ca1e7c",
    "relationId": "",
    "fees": [
        {
            "amount": 25,
            "currency": "USD",
            "feeType": "HANDLING"
        }
    ]
}

GlobalAccountTransaction 属性

id string

交易ID

code string

消息码

messageCode string

消息

accountId string

账户ID

counterparty string

对手方

amount double

交易金额

transactionDisplayId string

交易ID

businessType string

业务类型 PAYMENT, REFUND, DEPOSIT

status string

业务类型可能的值: PENDING, CLOSED, FAIL

payeeId string

受益人ID

reference string

交易目的

memo string

交易备注

balanceId string

钱包ID

currency string

交易币种

clientTransactionId string

客户端交易ID

relationId string

这个退款的时候，这个字段是原始交易ID

fees string

费用 Object

Payout

付款对象

成功示例

{
    "clientTransactionId": "27085007-8f33-4d1b-b775-71452008eeca",
    "businessId": "1e661454-82e5-4e75-876a-b909cb3e4df9",
    "businessType": "GLOBAL_ACCOUNT",
    "balanceId": "d644d1ee-4dc0-42f2-8f01-3e142a06d4bc",
    "payeeId": "1892884241312153602",
    "fromAmount": 2000,
    "fromCurrency": "USD",
    "toAmount": 267.92,
    "toCurrency": "USD",
    "status": "CLOSED",
    "message": "Success",
    "createTime": 1739155110365,
    "fees": {
        "amount": 2,
        "currency": "USD",
        "feeType": "HANDLING"
    }
}

成功属性

clientTransactionId string

商户交易id

businessId string

业务ID：根据支付类型的不同，返回对应的业务ID。若支付类型为全球账户支付，则返回全球账户的ID；若支付类型为加密资产支付，则返回加密资产的ID。

businessType string

businessType 字段用于表示支付的类型。该字段的值可以是以下之一：

GlobalAccountPayment：表示全球账户支付类型。
CryptoAssetPayment：表示加密资产支付类型。

balanceId string

钱包id

payeeId string

受益人ID

fromCurrency string

出金币种

fromAmount double

出金金额

toCurrency string

付款币种

toAmount double

付款金额

status string

PENDING, CLOSED, FAIL

message string

Message

createTime long

创建时间

fees string

费用 Fee

退款示例

{
    "clientTransactionId": "27085007-8f33-4d1b-b775-71452008eeca",
    "businessId": "1e661454-82e5-4e75-876a-b909cb3e4df9",
    "businessType": "GLOBAL_ACCOUNT",
    "balanceId": "d644d1ee-4dc0-42f2-8f01-3e142a06d4bc",
    "payeeId": "1892884241312153602",
    "fromAmount": 2000,
    "fromCurrency": "USD",
    "toAmount": 267.92,
    "toCurrency": "USD",
    "status": "CLOSED",
    "message": "Success",
    "refund": {
        "amount": "239.92",
        "currency": "USD"
    },
    "createTime": 1739155110365,
    "fees": {
        "amount": 2,
        "currency": "USD",
        "feeType": "HANDLING"
    }
}

属性

clientTransactionId string

商户交易id

businessId string

businessType string

businessType 字段用于表示支付的类型。该字段的值可以是以下之一：

GlobalAccountPayment：表示全球账户支付类型。
CryptoAssetPayment：表示加密资产支付类型。

balanceId string

钱包id

payeeId string

受益人ID

fromCurrency string

出金币种

fromAmount double

出金金额

toCurrency string

付款币种

toAmount double

付款金额

status string

PENDING, CLOSED, FAIL

message string

Message

refund

退款信息退款

createTime long

创建时间

fees string

费用 Fee

退款对象

示例

{
  "refundAmount": 2,
  "refundCurrency": "USD"
}

属性

refundAmount double

退款金额

refundCurrency double

退款币种

手续费资源

手续费对象

示例

{
  "amount": 2,
  "currency": "USD",
  "feeType": "HANDLING"
}

属性

amount string

金额的大小

currency string

金额的货币代码.

feeType string

指定交易过程中收取的手续费类型。

HANDLING：该字段表示平台在处理交易时收取的手续费。

全球收单Payin

Acquiring

收单成功示例

{
	"tradeNo": "202502241827138193879602322",
	"merchantTradeNo": "aaa64a7c49b-703f-44c9-a4ae-f1e0bd3f4e7c",
	"currency": "USD",
	"amount": "28",
	"status": "PAID",
	"transactionType": "PAYMENT",
	"createTime": "1740392833835",
	"completeTime": "1740394320039",
	"channelId": "100003",
	"merchantCustomerId": "testa577fb5c-cfa7-4c25-8a9b-5dd403b0f800",
	"subMerchantId": "1772818881448554498",
	"description": "description",
  "errorCode": "51",
  "errorMsg": "Insufficient funds"
}

成功属性

tradeNo string

QBit生成的订单id,幂等,用于商户后台查询

merchantTradeNo string

商户自行生成的订单id,全局唯一/幂等,用于商户后台查询

currency string

交易币种

amount string

订单金额

status string

订单状态
PENDING: 订单创建中
READY: 等待客户支付
PAID: 订单已支付
FAILED: 订单失败
CANCELED: 订单被客户取消
REFUNDING: 订单退款中
REFUNDED: 订单已退款
CANCELING: 订单取消中
AUTHORIZED: 订单已授权
REFUNDING: 订单退款中
REVOKING: 订单撤销中
REVOKED: 订单已撤销
SENT_CAPTURE: 已请求支付捕获
CAPTURED: 支付已捕获
CLOSED: 订单已关闭（通常由于过期）

transactionType string

订单类型

PAYMENT: 支付
REFUND: 退款

createTime string

订单创建时间

completeTime string

订单完成时间

channelId string

支付方式ID

merchantCustomerId string

商户自行上传的顾客id

subMerchantId string

子商户ID

description string

商户传的信息,会原样返回

errorCode string

错误码

errorMsg string

错误信息

核心资源

Account 对象

示例

Account 属性

User 对象

示例

User 属性

FaceAuthentication 对象

示例

FaceAuthentication 属性

Balance 对象

示例

Balance 属性

量子卡资源

Budget 对象

示例

Budget 属性

Card 对象

示例

Card 属性

CardTransaction 对象

示例

CardTransaction 属性

BudgetTransaction 对象

示例

BudgetTransaction 属性

Cardholder

示例

Cardholder 属性

全球账户资源

BankAccount 对象

示例

全球账户 属性

GlobalAccountTransaction 对象

示例

GlobalAccountTransaction 属性

Payout

付款对象

成功示例

成功属性

退款示例

属性

退款对象

示例

属性

手续费资源

手续费对象

示例

属性

全球收单Payin

Acquiring

收单成功示例

成功属性

全球账户属性