Danh sách API

• Xác thực
  • postLấy token xác thực
• Ngân hàng
  • getLấy danh sách ngân hàng
  • getLấy danh sách ngân hàng với chi nhánh
• Lô lệnh chi
  • postTạo lô lệnh chi
  • getTruy vấn lô lệnh chi
  • postDuyệt lô lệnh chi
• Nguồn tiền
  • getLấy danh sách nguồn tiền
  • postTạo nguồn tiền
  • getTruy vấn nguồn tiền
• Webhooks
  • postTạo webhook
  • getLấy danh sách webhook
  • getTruy vấn webhook

API docs by Redocly

BIZZI PAY API (1.0.0)

Download OpenAPI specification:Download

Bizzi Pay API

Xác thực

Lấy token xác thực

Request Body schema: application/json

required

clientId required	string Id của client
clientSecret required	string Secret của client

Responses

https://pay-dev.bizzi.services/v1/auth/token

Request samples

• Payload

Content type

application/json

{

• "clientId": "d3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
• "clientSecret": "abcxyz01234"

}

Ngân hàng

Lấy danh sách ngân hàng

Authorizations:

bearer

query Parameters

page	number Default: 1
size	number Default: 20 Số lượng bản ghi trên mỗi trang

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Responses

https://pay-dev.bizzi.services/v1/banks

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "banks": [

    • {

      • "bankId": "0678fc6-17bc-4f70-a349-ff4e47b6f172",
      • "bin": "970426",
      • "name": "Ngân hàng Thương mại Cổ phần Hàng Hải Việt Nam (Maritime Bank)",
      • "shortName": "MSB",
      • "swiftCode": "MSBVVNVX",
      • "logo": "https://example.com/logo.png"

      }

    ]

  },
• "message": "string"

}

Lấy danh sách ngân hàng với chi nhánh

Authorizations:

bearer

path Parameters

id required

string

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Responses

https://pay-dev.bizzi.services/v1/banks/{id}/branches

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "bank": {

    • "bankId": "0678fc6-17bc-4f70-a349-ff4e47b6f172",
    • "bin": "970426",
    • "name": "Ngân hàng Thương mại Cổ phần Hàng Hải Việt Nam (Maritime Bank)",
    • "shortName": "MSB",
    • "swiftCode": "MSBVVNVX",
    • "logo": "https://example.com/logo.png"

    },
  • "branches": [

    • {

      • "bankBranchId": "0678fc6-17bc-4f70-a349-ff4e47b6f172",
      • "code": "970426",
      • "name": "Chi nhánh Hồ Chí Minh"

      }

    ]

  },
• "message": "string"

}

Lô lệnh chi

Tạo lô lệnh chi

Authorizations:

bearer

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Request Body schema: application/json

required

sofId required	string Id của nguồn tiền
required	Array of objects (CreateOnePaymentOrderReq)

Responses

https://pay-dev.bizzi.services/v1/payment-order-batches

Request samples

• Payload

Content type

application/json

{

• "sofId": "5f4c7f0e-7d7f-4d1b-8c3f-0c1f3b2b8e3b",
• "paymentOrders": [

  • {

    • "refId": "ref-1234567890",
    • "amount": 1000000,
    • "accountName": "NGUYEN VAN A",
    • "accountNumber": "123456789",
    • "bankCode": "MSB",
    • "branchCode": "970123",
    • "channel": "CITAD",
    • "remark": "CTY ABC THANH TOAN HANG HOA - ABC123"

    }

  ]

}

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "paymentOrderBatchId": "string"

  },
• "message": "string"

}

Truy vấn lô lệnh chi

Authorizations:

bearer

path Parameters

id required

string

query Parameters

refId required

string

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Responses

https://pay-dev.bizzi.services/v1/payment-order-batches/{id}

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "reviewStatus": "approved",
  • "transactions": [

    • {

      • "transactionId": "5f4c7f0e-7d7f-4d1b-8c3f-0c1f3b2b8e3b",
      • "refId": "ref-1234567890",
      • "amount": 1000000,
      • "accountName": "NGUYEN VAN A",
      • "accountNumber": "123456789",
      • "bankCode": "MSB",
      • "branchCode": "970123",
      • "channel": "CITAD",
      • "remark": "CTY ABC THANH TOAN HANG HOA - ABC123",
      • "status": "success"

      }

    ]

  },
• "message": "string"

}

Duyệt lô lệnh chi

Authorizations:

bearer

path Parameters

id required

string

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Request Body schema: application/json

required

otp required

string Mã OTP

Responses

https://pay-dev.bizzi.services/v1/payment-order-batches/{id}/confirm

Request samples

• Payload

Content type

application/json

{

• "otp": "123456"

}

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "status": "approved"

  },
• "message": "string"

}

Nguồn tiền

Lấy danh sách nguồn tiền

Authorizations:

bearer

query Parameters

page	number Default: 1
size	number Default: 20 Số lượng bản ghi trên mỗi trang

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Responses

https://pay-dev.bizzi.services/v1/sofs

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "sofs": [

    • {

      • "sofId": "123e4567-e89b-12d3-a456-426614174000",
      • "bin": "970431",
      • "bankAccountNumber": "1234567890",
      • "bankAccountName": "NGUYEN VAN A",
      • "branchCode": "Chi nhánh Hồ Chí Minh",
      • "type": "account",
      • "bankNostro": "11001011234215",
      • "balance": 1000000

      }

    ]

  },
• "message": "string"

}

Tạo nguồn tiền

Authorizations:

bearer

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Request Body schema: application/json

required

bin required	string Mã BIN của ngân hàng, quy định bởi ngân hàng nhà nước
bankAccountNumber required	string Số tài khoản ngân hàng
bankAccountName required	string Tên tài khoản ngân hàng
branchCode	string Tên chi nhánh tại ngân hàng
type required	string Default: "account" Loại nguồn tiền
bankNostro	string Số tài khoản nostro

Responses

https://pay-dev.bizzi.services/v1/sofs

Request samples

• Payload

Content type

application/json

{

• "bin": "970431",
• "bankAccountNumber": "1234567890",
• "bankAccountName": "NGUYEN VAN A",
• "branchCode": "Chi nhánh Hồ Chí Minh",
• "type": "account",
• "bankNostro": "11001011234215"

}

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "sofId": "123e4567-e89b-12d3-a456-426614174000",
  • "bin": "970431",
  • "bankAccountNumber": "1234567890",
  • "bankAccountName": "NGUYEN VAN A",
  • "branchCode": "Chi nhánh Hồ Chí Minh",
  • "type": "account",
  • "bankNostro": "11001011234215",
  • "balance": 1000000

  },
• "message": "string"

}

Truy vấn nguồn tiền

Authorizations:

bearer

path Parameters

id required

string

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Responses

https://pay-dev.bizzi.services/v1/sofs/{id}

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "sofId": "123e4567-e89b-12d3-a456-426614174000",
  • "bin": "970431",
  • "bankAccountNumber": "1234567890",
  • "bankAccountName": "NGUYEN VAN A",
  • "branchCode": "Chi nhánh Hồ Chí Minh",
  • "type": "account",
  • "bankNostro": "11001011234215",
  • "balance": 1000000

  },
• "message": "string"

}

Webhooks

Tạo webhook

Authorizations:

bearer

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Request Body schema: application/json

required

eventName required	string Value: "payment_order_batches.update" Tên sự kiện
endpoint required	string Đường dẫn Endpoint
headers required	Array of strings Tùy chỉnh header cho webhook

Responses

https://pay-dev.bizzi.services/v1/webhooks

Request samples

• Payload

Content type

application/json

{

• "eventName": "payment_order_batches.update",
• "endpoint": "https://example.com/webhook",
• "headers": [

  • {

    • "key": "custom-key",
    • "value": "value"

    }

  ]

}

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "webhookId": "123e4567-e89b-12d3-a456-426614174000",
  • "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  • "merchantClientId": "123e4567-e89b-12d3-a456-426614174000",
  • "eventName": "payment_order_batches.update",
  • "endpoint": "https://example.com/webhook",
  • "headers": [

    • {

      • "key": "custom-key",
      • "value": "value"

      }

    ]

  },
• "message": "string"

}

Lấy danh sách webhook

Authorizations:

bearer

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Responses

https://pay-dev.bizzi.services/v1/webhooks

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "webhooks": [

    • {

      • "webhookId": "123e4567-e89b-12d3-a456-426614174000",
      • "merchantId": "123e4567-e89b-12d3-a456-426614174000",
      • "merchantClientId": "123e4567-e89b-12d3-a456-426614174000",
      • "eventName": "payment_order_batches.update",
      • "endpoint": "https://example.com/webhook",
      • "headers": [

        • {

          • "key": "custom-key",
          • "value": "value"

          }

        ]

      }

    ]

  },
• "message": "string"

}

Truy vấn webhook

Authorizations:

bearer

path Parameters

id required

string

header Parameters

x-merchant-request-id required	string Id đối tác gửi theo request
x-merchant-request-time required	string Unix milisecond UTC
x-merchant-request-signature required	string Chữ ký của request. Xem thêm cách mã hóa dữ liệu

Responses

https://pay-dev.bizzi.services/v1/webhooks/{id}

Response samples

• default

Content type

application/json

{

• "statusCode": 200,
• "data": {

  • "webhookId": "123e4567-e89b-12d3-a456-426614174000",
  • "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  • "merchantClientId": "123e4567-e89b-12d3-a456-426614174000",
  • "eventName": "payment_order_batches.update",
  • "endpoint": "https://example.com/webhook",
  • "headers": [

    • {

      • "key": "custom-key",
      • "value": "value"

      }

    ]

  },
• "message": "string"

}