API docs by Redocly

Notibox API docs (v0)

Download OpenAPI specification:Download

External Transaction Controller

API gọi từ đối tác

Tạo giao dịch

Authorizations:
bearerAuth
Request Body schema: application/json
required
amount
required
integer <int64>
bin
required
string
accountNo
required
string
accountName
required
string
content
string
timeout
integer <int64>
deviceId
required
string

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "bin": "string",
  • "accountNo": "string",
  • "accountName": "string",
  • "content": "string",
  • "timeout": 0,
  • "deviceId": "string"
}

Thông báo giao dịch

Authorizations:
bearerAuth
Request Body schema: application/json
required
refTransactionId
required
string
bin
required
string
accountNo
required
string
accountName
required
string
fromBin
required
string
fromAccountNo
required
string
amount
required
integer <int64>
content
string
deviceId
required
string
completedTime
required
string
timeDateTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "refTransactionId": "string",
  • "bin": "string",
  • "accountNo": "string",
  • "accountName": "string",
  • "fromBin": "string",
  • "fromAccountNo": "string",
  • "amount": 0,
  • "content": "string",
  • "deviceId": "string",
  • "completedTime": "string",
  • "timeDateTime": "2019-08-24T14:15:22Z"
}

Lấy chi tiết giao dịch

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Lấy danh sách giao dịch

Authorizations:
bearerAuth
query Parameters
fromDate
string <date-time>
toDate
string <date-time>
minAmount
integer <int64>
maxAmount
integer <int64>
deviceId
string
accountNumber
string
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

External Device Controller

API gọi từ đối tác

Hủy liên kết thiết bị

Authorizations:
bearerAuth
Request Body schema: application/json
required
deviceId
required
string

Responses

Request samples

Content type
application/json
{
  • "deviceId": "string"
}

Liên kết thiết bị

Authorizations:
bearerAuth
Request Body schema: application/json
required
hardwareId
required
string
pairingKey
required
string

Responses

Request samples

Content type
application/json
{
  • "hardwareId": "string",
  • "pairingKey": "string"
}

Lấy chi tiết thiết bị

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Lấy danh sách thiết bị

Authorizations:
bearerAuth
query Parameters
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

External Static QR Controller

API gọi từ đối tác

Chỉnh sửa một qr ví điện tử tĩnh

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
type
required
string
Enum: "MOMO" "ZALO_PAY" "MOCA" "VN_PAY"
qrCode
required
string
accountNo
required
string
accountName
required
string
content
string
isDefault
boolean

Responses

Request samples

Content type
application/json
{
  • "type": "MOMO",
  • "qrCode": "string",
  • "accountNo": "string",
  • "accountName": "string",
  • "content": "string",
  • "isDefault": true
}

Chỉnh sửa một qr ngân hàng tĩnh

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
bin
required
string
accountNo
required
string
accountName
required
string
content
string
isDefault
boolean

Responses

Request samples

Content type
application/json
{
  • "bin": "string",
  • "accountNo": "string",
  • "accountName": "string",
  • "content": "string",
  • "isDefault": true
}

Tạo một qr ví điện tử tĩnh

Authorizations:
bearerAuth
Request Body schema: application/json
required
deviceId
required
string
type
required
string
Enum: "MOMO" "ZALO_PAY" "MOCA" "VN_PAY"
qrCode
required
string
accountNo
required
string
accountName
required
string
content
string
isDefault
boolean

Responses

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "type": "MOMO",
  • "qrCode": "string",
  • "accountNo": "string",
  • "accountName": "string",
  • "content": "string",
  • "isDefault": true
}

Tạo một qr ngân hàng tĩnh

Authorizations:
bearerAuth
Request Body schema: application/json
required
deviceId
required
string
bin
required
string
accountNo
required
string
accountName
required
string
content
string
isDefault
boolean

Responses

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "bin": "string",
  • "accountNo": "string",
  • "accountName": "string",
  • "content": "string",
  • "isDefault": true
}

Lấy chi tiết qr tĩnh

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Xóa một qr tĩnh

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Lấy danh sách QR tĩnh

Authorizations:
bearerAuth
query Parameters
deviceId
string
type
string
Enum: "BANK" "E_WALLET" "UMEE" "KLB"
page
integer >= 0
Default: 0

Zero-based page index (0..N)

size
integer >= 1
Default: 20

The size of the page to be returned

sort
Array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses