LogoLogo
  • Ứng dụng VinID
  • Giới thiệu chung
    • Dịch vụ thanh toán VinID Pay
    • Dịch vụ loyalty VinID Point
    • Quy trình tích hợp
  • Tài liệu tích hợp
    • Môi trường tích hợp
    • Quy tắc kết nối chung
      • Request Header
      • X-Key-Code
      • Signature - chữ kí điện tử
      • Ví dụ Request / Response
      • Extra Data
    • OneID SSO Integration (PKCE)
      • Auth endpoint
      • Token endpoint
      • Refresh token
      • Logout endpoint
      • Profile endpoint
      • OpenID Configuration
    • Tích hợp với VinID Pay
      • Thanh toán Merchant QR
      • Thanh toán Transaction QR
      • Thanh toán App to App
      • Thanh toán Web Payment
      • Thanh toán Linked Account
      • Dịch vụ chi hộ
      • Callback / IPN
      • Refund giao dịch
    • Tích hợp với VinID Loyalty
      • Dịch vụ lấy hạng thành viên trung thành
      • Dịch vụ VinID Giftcode
        • Deprecated APIs
      • Dịch vụ Topup VinID Point
        • Deprecated APIs
    • Tích hợp với VinID Voucher
      • Dịch vụ E-Voucher
    • Mã lỗi chung
  • Đối soát
    • Đối soát Ví điện tử VinID Pay
  • Khác
    • Thuật ngữ
    • Câu hỏi thường gặp
    • Ứng dụng quản lý
      • Merchant Mobile App
      • Merchant Website
    • Thông tin hỗ trợ
Powered by GitBook
On this page
  • Giới thiệu dịch vụ
  • Hướng dẫn cách sử dụng mã Giftcode
  • Luồng người dùng sử dụng dịch vụ
  • Sơ đồ xử lý kỹ thuật
  • APIs
  • Check quantity
  • Withdraw Giftcode
  • Check giftcode
  • Get order detail
  • Mã lỗi

Was this helpful?

Export as PDF
  1. Tài liệu tích hợp
  2. Tích hợp với VinID Loyalty

Dịch vụ VinID Giftcode

PreviousDịch vụ lấy hạng thành viên trung thànhNextDeprecated APIs

Last updated 3 years ago

Was this helpful?

Giới thiệu dịch vụ

Người dùng hiện nay đã không còn xa lạ với VinID Gift Card - là những chiếc thẻ cứng của VinID với những mệnh giá khác nhau từ 50.000đ đến 10.000.000đ sử dụng để nạp điểm thẻ vào tài khoản VinID của mình và tiêu dùng tại hệ sinh thái của Tập đoàn Vingroup và các đối tác của VinID.

Để nâng cao sự tiện lợi trong kỷ nguyên số, VinID cung cấp dịch vụ mua mã Giftcode cho phép đối tác tích hợp chủ động mua mã thẻ Gift Card để cung cấp đến người dùng cuối bằng hệ thống của chính mình. Người dùng thực hiện nạp mã vào tài khoản VinID để sử dụng.

Lưu ý

Điểm VinID được nạp bằng Giftcard/Giftcode có thể sử dụng ngay sau khi nạp

Hướng dẫn cách sử dụng mã Giftcode

Cách 1: Nạp qua SMS Soạn tin nhắn theo cú pháp VinID[dấu cách][số thẻ VinID][dấu cách][mã nạp điểm] gửi đến 6067

Cách 2: Nạp qua ứng dụng VinID Truy cập ứng dụng VinID, trong mục Tiện ích, chọn Nạp điểm, nhập mã Giftcode và ấn Tiếp tục.

Luồng người dùng sử dụng dịch vụ

Đối tác có thể sử dụng Giftcode cho nhiều mục đích khác nhau tùy thuộc vào nghiệp vụ của mình như: mua bán, trao đổi, tặng thưởng, … Sơ đồ dưới đây minh họa cho nghiệp vụ Đổi VinID Giftcode của đối tác có hệ thống điểm loyalty riêng.

Sơ đồ xử lý kỹ thuật

APIs

Lưu ý:

  • Mã code nạp điểm sẽ được mã hóa bằng thuật toán RSA-2048. Đối tác cần chuẩn bị 1 cặp private / public key để thực hiện việc mã hóa / giải mã code. Public key sẽ được cung cấp cho VinID để thực hiện mã hóa.

  • Đối tác có trách nhiệm bảo vệ private key của mình không để lộ ra ngoài. Cặp key này sẽ không được phép thay đổi trên môi trường Production.

  • Cặp khóa để mã hóa giftcode là riêng biệt với các cặp khóa tạo X-Key-Code để kết nối API.

Check quantity

POST {API-HOST}/merchant-integration/v1/gateway

API để kiểm tra số lượng giftcode còn lại trong kho của merchant.

Headers

Name
Type
Description

X-API-Code*

String

mi_v1_loyalty_giftcode_quantity

Request Body

Name
Type
Description

merchant_id*

string

Mã cửa hàng của merchant tại VinID

terminal_id*

string

Mã máy POS của merchant tại VinID

card_type

array

Danh sách mệnh giá giftcode cần kiểm tra Đơn vị: nghìn đồng Ví dụ: [“10”, "50", "100"]

merchant_code*

string

Mã của merchant tại VinID

{
  "meta": {
    "code": 200,
    "message": "OK"
  },
  "data": [
    {
      "card_type": "string",
      "quantity": 0
    }
  ]
}

Withdraw Giftcode

POST {API-HOST}/merchant-integration/v1/gateway

API để lấy giftcode ra khỏi kho

Headers

Name
Type
Description

X-API-Code*

string

mi_v1_loyalty_giftcode_orders

Request Body

Name
Type
Description

merchant_id*

string

Mã cửa hàng của merchant tại VinID

terminal_id*

string

Mã máy pos của merchant tại VinID

order_id*

string

Mã order unique phía merchant tự sinh

order_info*

array

Thông tin của lệnh lấy giftcode

card_type*

string

Mệnh giá giftcode cần lấy Đơn vị: nghìn đồng

quantity*

integer

Số lượng giftcode cần lấy

merchant_code*

String

Mã của merchant tại VinID

{
  "meta": {
    "code": int,
    "message": "string"
  },
  "data": {
    "created_at": 0,
    "extra_data: "string"
    "merchant_order_id": "string",
    "order_info": [
      {
        "card_type": "string", //Mệnh giá giftcode
        "cards": [
          {
            "code": "string", //Mã nạp của giftcode
            "expire_date": "string", //Ngày hết hạn
            "serial": "string" //Mã tra soát
          }
        ]
      }
    ]
  }
}
REQUEST TEMPLATE
{
  "merchant_code": string,
  "merchant_id": string,
  "terminal_id": string,
  "order_info": [
    {
      "quantity": integer,
      "card_type": string
    }
  ],
  "order_id": string
}

Check giftcode

POST {API-HOST}/merchant-integration/v1/gateway

API để kiểm tra trạng thái của giftcode

Headers

Name
Type
Description

X-API-Code*

string

mi_v1_loyalty_giftcode_status

Request Body

Name
Type
Description

merchant_id*

string

Mã cửa hàng của merchant tại VinID

terminal_id*

string

Mã máy pos của merchant tại VinID

serial*

string

Mã serial của giftcode cần kiểm tra

merchant_code*

String

Mã của merchant tại VinID

{
  "meta": {
    "code": int,
    "message": "string"
  },
  "data": {
    "status": "USED", //“USED” hoặc “ACTIVE”
    "expire_date": "yyyy-MM-dd" //Hạn sử dụng
  }
}
{
  "meta": {
    "code": int,
    "message": "string"
  },
  "data": null
}

Get order detail

POST {API-HOST}/merchant-integration/v1/gateway

API để yêu cầu lấy thông tin của đơn hàng đã thực hiện

Headers

Name
Type
Description

X-API-Code*

string

mi_v1_loyalty_giftcode_detail

Request Body

Name
Type
Description

merchant_code*

String

Mã của merchant tại VinID

merchant_id*

String

Mã cửa hàng của merchant tại VinID

terminal_id*

String

Mã máy POS của merchant tại VinID

order_id*

String

Mã order unique phía merchant tự sinh

{
  "meta": {
    "code": int,
    "message": "string"
  },
  "data": {
    "created_at": 0,
    "extra_data": "string",
    "merchant_order_id": "string",
    "order_info": [
      {
        "card_type": "string",
        "cards": [
          {
            "code": "string", //Mã nạp của giftcode
            "expire_date": "string", //Ngày hết hạn
            "serial": "string" //Mã tra soát
          }
        ]
      }
    ]   
  }
}

Mã lỗi

Code

Message

4000

Dữ liệu không hợp lệ

200100

Số lượng giftcode trong kho không đủ

200200

Mã order đã tồn tại

5000

Hệ thống xảy ra lỗi khi xử lý yêu cầu

Xem thêm:

Tham khảo bảng

Mã lỗi chung
API Host
Quy tắc kết nối
VinID Giftcard