API Kiểm tra và lấy thông tin GD

a. Tổng quan

- Phương thức gửi nhận: POST JSON

- HTTP Request: POST <BASE_URL> /get-transaction-info

b. Data Request (Thông tin gửi sang Alepay)

Tên trường

Định dạng

Bắt buộc

Mặc định

Mô tả

tokenKey

String

T

  

Mã token key do alepay cung cấp khi đăng ký tài khoản trên Alepay

transactionCode

String

T

  

Mã giao dịch tại Alepay

signature

String

T

  

Chữ ký để kiểm tra thông tin. Xem hướng dẫn tạo Signature.

 

c. Data Response (Thông tin nhận về từ Alepay)

Tên trường

Định dạng

Mô tả

code

String

Mã lỗi. Dùng để kiểm tra tính đúng đắn của dữ liệu gửi lên

message

String

Mô tả lỗi

transactionCode

String

Mã giao dịch tại Alepay, sử dụng để thực hiện đối soát

orderCode

String

Mã đơn hàng của Merchant

amount

String

Giá trị đơn hàng

currency

String

Loại tiền tệ

buyerEmail

String

Email người mua hàng

buyerPhone

String

Số điện thoại người mua

cardNumber

String

Thông tin thẻ khách hàng (6 số đầu và 4 số cuối)

buyerName

String

Tên người mua hàng

status

String

Tình trạng giao dịch (check theo phụ lục bảng mã lỗi). Sử dụng giá trị này để biết giao dịch đã thành công hay chưa

reason

String

Lý do thất bại (nếu có)

description

String

Mô tả trạng thái giao dịch

installment

boolean

True : Giao dịch trả góp, False: Giao dịch thường

is3D

boolean

True : Thẻ 3D, False: Thẻ 2D

month

Integer

Chu kỳ trả góp

bankCode

String

Mã ngân hàng trả góp

bankName

String

Tên ngân hàng trả góp

method

String

Loại thẻ

transactionTime

Long

Thời gian thực hiện thanh toán (millisecond)

successTime

Long

Thời gian thanh toán thành công (millisecond)

bankHotline

String

Số Hotline của ngân hàng trả góp

merchantFee

double

Phí merchant

payerFee

double

Phí người thanh toán

bankType

string

Loại ngân hàng phát hành:

  • INTERNATIONAL: Thẻ phát hành bởi ngân hàng ngoài Việt nam

  • DOMESTIC: Thẻ phát hành bởi ngân hàng Việt Nam

authenCode

string

Mã chuẩn chi (nếu có)

promotionCode

string

Mã chương trình khuyến mãi. 

Giao dịch được hưởng CTKM Ngân lượng Discount sẽ trả thêm thông tin trường này.

discountAmount

number

Số tiền Ngân lượng trợ phí trả góp người mua.

Giao dịch được hưởng CTKM Ngân lượng Discount sẽ trả thêm thông tin trường này.

signature

String

Chữ ký để kiểm tra thông tin. Xem hướng dẫn tạo Signature.

Note: Signature được make theo các trường thông tin trả về trong response data

 

d. Demo API

- Data Request:

  {
      "signature": "e4d8566e368db2e3b0c356a76783d66ad9bc963020ce5a12ed5bb115f2ca31e6",
      "tokenKey": "SI85PMt00k9SfmIbupQinvHVPCHYUd",
      "transactionCode": "ALE00TKG5"
  }

- Data Response:

  {
      "code": "000",
      "message": "Thành công",
      "signature": "6770c33175f483db8347bf7227438907ddad48c37b8fc62528fc2651c5914fdb",
      "transactionCode": "ALE00TKG5",
      "orderCode": "ALE30_API_1110",
      "amount": "3000000",
      "currency": "VND",
      "buyerEmail": "virtual_buyer@alepay.vn",
      "buyerPhone": "0321654987",
      "cardNumber": "445653-XXXX-1005",
      "buyerName": "Virtual Buyer",
      "status": "000",
      "reason": "Giao dịch thành công",
      "description": "Thành công",
      "installment": true,
      "is3D": null,
      "month": 3,
      "bankCode": "SACOMBANK",
      "bankName": "NH TMCP Sài Gòn Thương Tín",
      "method": "VISA",
      "bankType": "DOMESTIC",
      "transactionTime": 1728631384032,
      "successTime": 1728631462011,
      "bankHotline": "1900 5555 88 - 08 526 6060",
      "merchantFee": 40209,
      "payerFee": 30100,
      "authenCode": null
  }