Deprecated APIs

APIs

Get user info by phone number

GET {API-HOST}/merchant-integration/v1/loyalty/topup/member?{parameters}

API cho merchant để kiểm tra thông tin của số điện thoại người dùng.

Path Parameters

Name

Type

Description

phone_number

string

Số điện thoại của người dùng theo định dạng 0xxxxxxx. Tối thiểu 10 ký tự. Tối đa 11 ký tự

store_code

string

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

pos_code

string

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

{
  "meta": {
    "code": int,
    "message": "string"
  },
  "data": {
    "full_name":        string,
    "phone_number":     string,
    "dob":              string,
    "gender":           string,
    "identify":         string,  // Số điện thoại cá nhân
    "status":           string,  // A: Active | I: Inactive | B: Block
    "card_status":      string   // A: Active | I: Inactive
  }
}

REQUEST TEMPLATE

{API-HOST}/merchant-integration/v1/loyalty/topup/member?phone_number=string&store_code=string&pos_code=string

Top-up points to phone number

POST {API-HOST}/merchant-integration/v1/loyalty/topup

API để nạp điểm cho số điện thoại người dùng

Request Body

Name

Type

Description

phone_number

string

Số điện thoại nhận điểm theo định dạng 0xxxxxxx Tối thiểu 10 ký tự. Tối đa 11 ký tự.

store_code

string

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

pos_code

string

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

point_amount

integer

Số điểm cần nạp. Tối thiểu 50 .Tối đa 20000000 Nhỏ hơn 20000 nếu xuất hóa đơn

order_id

string

Mã hóa đơn của merchant

txn_id

string

Mã giao dịch nạp điểm của đối tác với VinID. Tối đa 23 ký tự. Merchant tự sinh unique theo định dạng {{store_code}}xxxx

send_receipt

boolean

Yêu cầu xuất hóa đơn true: có. false : không

receipt_info

object

Thông tin để xuất hóa đơn Tất cả các trường thông tin bên dưới sẽ required nếu xuất hóa đơn

name

string

Tên ghi hóa đơn Tối đa 50 ký tự

address

string

Địa chỉ ghi hóa đơn Tối đa 100 ký tự

string

Email ghi hóa đơn (Yêu cầu truyền đúng định dạng) Tối đa 50 ký tự.

tax_code

string

Mã số thuế ghi hóa đơn. Tối đa 32 ký tự

{
  "meta": {
    "code": 200,
    "message": "OK"
}

REQUEST TEMPLATE

{
  "phone_number": "string",
  "store_code" : "string",
  "pos_code" : "string",
  "point_amount":2,
  "order_id": "string",
  "txn_id":"string",
  "send_receipt": true/false,
  "receipt_info": {
    "name": "string",
    "address": "string",
    "email": "string",
    "tax_code": "string"
    }
}

Query order status

GET {API-HOST}/merchant-integration/v1/loyalty/topup/status?{parameters}

API để kiểm tra trạng thái đơn hàng

Path Parameters

Name

Type

Description

txn_id

string

Mã giao dịch nạp điểm cần kiểm tra (Là mã merchant đã dùng ở API nạp điểm)

store_code

string

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

pos_code

string

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

{
  "meta": {
    "code": int,
    "message": "string"
  },
  "data": {
    "type": "string", //TXN_SALE | TXN_EARN | TXN_BURN | TXN_REFUND
    "status": "string" //SUCCESS | ERROR
  }}

REQUEST TEMPLATE

{API-HOST}/merchant-integration/v1/loyalty/topup/status?txn_id=string&store_code=string&pos_code=string

Mã lỗi

Code

Message

4000001

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

4000306

Thẻ chưa được kích hoạt hoặc tạm thời bị khóa

4000307

TnxID đã tồn tại

4000315

Tài khoản không tồn tại

4000318

Tài khoản có nguy cơ tiềm ẩn

4000326

Tài khoản chưa được kích hoạt hoặc tạm thời bị khóa

4000328

Quá giới hạn số điểm cho phép để xuất hóa đơn

4010001

Lỗi trong quá trình chứng thực yêu cầu

4030302

Store/POS không tồn tại

Tham khảo bảng Mã lỗi chung

Xem thêm:

PreviousDịch vụ Topup VinID Point NextTích hợp với VinID Voucher

Last updated 2 years ago