API Reference
1. Info
- Title: gRPC API
- Version: 1.0.0
- Description: This documentation is generated from protobuf files using protoc-gen-doc.
2. Paths
NotabeneBridge
GetVASPInfo
- Summary: 查询DID信息
- Method:
GetVASPInfo - Endpoint:
notabene_bridge.NotabeneBridge/GetVASPInfo - Request:
- Content-Type:
application/grpc - Schema: GetVASPInfoRequest
- Content-Type:
- Response:
- Content-Type:
application/grpc - Schema: GetVASPInfoResponse
- Content-Type:
CreateTx
- Summary: Create
- Method:
CreateTx - Endpoint:
notabene_bridge.NotabeneBridge/CreateTx - Request:
- Content-Type:
application/grpc - Schema: CreateTxRequest
- Content-Type:
- Response:
- Content-Type:
application/grpc - Schema: CreateTxResponse
- Content-Type:
RegisterWebhook
- Summary: 注册webhook
- Method:
RegisterWebhook - Endpoint:
notabene_bridge.NotabeneBridge/RegisterWebhook - Request:
- Content-Type:
application/grpc - Schema: RegisterWebhookRequest
- Content-Type:
- Response:
- Content-Type:
application/grpc - Schema: RegisterWebhookResponse
- Content-Type:
3. Components
3.1 Schemas
Beneficiary
收款方
| Field | Type | Description |
|---|---|---|
| beneficiaryPersons | Person | 收款方个人信息 |
| accountNumber | string | 收款方账户号 |
CreateTxRequest
创建交易请求
| Field | Type | Description |
|---|---|---|
| transactionRef | string | 交易参考号 |
| transactionAsset | string | 交易资产类型 |
| transactionAmount | string | 交易金额 |
| originatorVaspDid | string | 发起方VASP的DID |
| beneficiaryVaspDid | string | 收款方VASP的DID |
| beneficiaryRef | string | 收款方参考号 |
| originatorRef | string | 发起方参考号 |
| transactionBlockchainInfo | TransactionBlockchainInfo | 区块链相关信息 |
| originator | Originator | 发起方信息 |
| beneficiary | Beneficiary | 收款方信息 |
CreateTxResponse
创建交易响应
| Field | Type | Description |
|---|---|---|
| transactionRef | string | 交易参考号 |
| transactionID | string | 交易ID |
| transactionType | string | 交易类型 |
DateAndPlaceOfBirth
出生日期及地点
| Field | Type | Description |
|---|---|---|
| dateOfBirth | string | 出生日期 |
| placeOfBirth | string | 出生地点 |
GeographicAddress
地理地址
| Field | Type | Description |
|---|---|---|
| addressType | string | 地址类型 |
| streetName | string | 街道名 |
| buildingNumber | string | 楼号 |
| buildingName | string | 楼名 |
| townName | string | 城镇名 |
| countrySubDivision | string | 州/省/地区 |
| postCode | string | 邮编 |
| country | string | 国家 |
GetVASPInfoRequest
查询VASP信息请求
| Field | Type | Description |
|---|---|---|
| name | string | vasp名称 |
GetVASPInfoResponse
查询VASP信息响应
| Field | Type | Description |
|---|---|---|
| vASPs | VASP | VASP列表 |
| page | int32 | 当前页码 |
| perPage | int32 | 每页数量 |
| total | int32 | 总数 |
| order | string | 排序方式 |
Name
姓名
| Field | Type | Description |
|---|---|---|
| nameIdentifier | NameIdentifier | 姓名标识 |
NameIdentifier
姓名标识
| Field | Type | Description |
|---|---|---|
| primaryIdentifier | string | 主标识 |
| secondaryIdentifier | string | 次标识 |
| nameIdentifierType | string | 标识类型 |
NationalIdentification
国民身份信息
| Field | Type | Description |
|---|---|---|
| countryOfIssue | string | 签发国家 |
| nationalIdentifier | string | 身份证号 |
| nationalIdentifierType | string | 身份证类型 |
| registrationAuthority | string | 注册机构 |
NaturalPerson
自然人
| Field | Type | Description |
|---|---|---|
| name | Name | 姓名 |
| geographicAddress | GeographicAddress | 地址 |
| nationalIdentification | NationalIdentification | 国民身份信息 |
| dateAndPlaceOfBirth | DateAndPlaceOfBirth | 出生日期及地点 |
| customerIdentification | string | 客户识别号 |
| countryOfResidence | string | 居住国家 |
Originator
发起方
| Field | Type | Description |
|---|---|---|
| originatorPersons | Person | 发起方个人信息 |
| accountNumber | string | 发起方账户号 |
Person
个人
| Field | Type | Description |
|---|---|---|
| naturalPerson | NaturalPerson | 自然人信息 |
RegisterWebhookRequest
注册webhook请求
| Field | Type | Description |
|---|---|---|
| url | string | webhook地址 |
RegisterWebhookResponse
注册webhook响应
| Field | Type | Description |
|---|
TransactionBlockchainInfo
区块链信息
| Field | Type | Description |
|---|---|---|
| destination | string | 区块链目标地址 |
VASP
VASP信息
| Field | Type | Description |
|---|---|---|
| did | string | did |
| name | string | 名称 |
| website | string | 网站 |
| incorporationCountry | string | 注册国家 |
3.2 Enums
4. Scalar Value Types
| Proto Type | Go Type | C++ Type | Java Type | Python Type | Notes |
|---|---|---|---|---|---|
| double | float64 | double | double | float | |
| float | float32 | float | float | float | |
| int32 | int32 | int32 | int | int | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. |
| int64 | int64 | int64 | long | int/long | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. |
| uint32 | uint32 | uint32 | int | int/long | Uses variable-length encoding. |
| uint64 | uint64 | uint64 | long | int/long | Uses variable-length encoding. |
| sint32 | int32 | int32 | int | int | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. |
| sint64 | int64 | int64 | long | int/long | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. |
| fixed32 | uint32 | uint32 | int | int | Always four bytes. More efficient than uint32 if values are often greater than 2^28. |
| fixed64 | uint64 | uint64 | long | int/long | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. |
| sfixed32 | int32 | int32 | int | int | Always four bytes. |
| sfixed64 | int64 | int64 | long | int/long | Always eight bytes. |
| bool | bool | bool | boolean | boolean | |
| string | string | string | String | str/unicode | A string must always contain UTF-8 encoded or 7-bit ASCII text. |
| bytes | []byte | string | ByteString | str | May contain any arbitrary sequence of bytes. |