API Tìm kiếm 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-history

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

orderCode

String

F

  

Mã đơn hàng

fromDate

long

F

  

Lấy các giao dịch được thực hiện trong khoảng thời gian từ fromDate

toDate

long

F

  

Lấy các giao dịch được thực hiện trong khoảng thời gian đến toDate

customerName

String

F

  

Tên khách hàng

customerEmail

String

F

  

Email khách hàng

customerPhone

String

F

  

Số điện thoại khách hàng

paymentMethod

String

F

  

Loại thẻ thanh toán

page

Integer

F

 0

Số thứ tự trang

pageSize

Integer

F

 20

Số kết quả trên mỗi trang (1-50)

language

String

F

  

Ngôn ngữ hiển thị:
- vi: tiếng việt
- en: tiếng anh

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 (được mô tả trong Phụ lục 12.a)

message

String

Mô tả lỗi

pageIndex

Integer

Số thứ tự trang hiện tại

pageSize

Integer

Số kết quả trên mỗi trang

pageCount

Long

Tổng số trang

dataCount

Long

Tổng số kết quả

data

Array

Danh sách giao dịch (Thông tin giao dịch được mô tả giống trong Response Data của API kiểm tra và lấy thông tin GD).

 

d. Demo API

- Data Request:

  {
      "tokenKey": "jWglwAv5WA5B8gguVsHxyitoPBEcco",
      "orderCode": null,
      "fromDate": null,
      "toDate": null,
      "customerName": null,
      "customerEmail": null,
      "customerPhone": null,
      "paymentMethod": null,
      "page": null,
      "pageSize": null,
      "language": "vi",
      "signature": "7ad311cc414eb8ddc12d07cb4b16589b3b1c345fb0ae922b571b8f977b845e4a"
  }

- Data Response:

  {
      "code": "000",
      "message": "Thành công",
      "pageIndex": 0,
      "pageSize": 20,
      "pageCount": 1,
      "dataCount": 5,
      "data": [
          {
              "transactionCode": "ALE00U1NT",
              "orderCode": "0001",
              "amount": 3000000,
              "currency": "VND",
              "buyerEmail": "hanguyen26109@gmail.com",
              "buyerPhone": "0963168911",
              "cardNumber": "412344-XXXX-0204",
              "buyerName": "Nguyen Van",
              "status": "150",
              "message": "Thẻ bị review",
              "reason": "Giao dịch thành công",
              "description": null,
              "installment": true,
              "is3D": false,
              "month": 4,
              "bankCode": "SACOMBANK",
              "bankName": "NH TMCP Sài Gòn Thương Tín",
              "method": "VISA",
              "bankHotline": "1900 5555 88 - 08 526 6060",
              "transactionTime": 1740730638982,
              "successTime": 0,
              "merchantFee": 25425,
              "payerFee": 40527
          },
          {
              "transactionCode": "ALE00U1NM",
              "orderCode": "0001",
              "amount": 3000000,
              "currency": "VND",
              "buyerEmail": "hanguyen26109@gmail.com",
              "buyerPhone": "0963168911",
              "cardNumber": "412344-XXXX-0204",
              "buyerName": "Nguyen Van",
              "status": "150",
              "message": "Thẻ bị review",
              "reason": "Giao dịch thành công",
              "description": null,
              "installment": true,
              "is3D": false,
              "month": 4,
              "bankCode": "SACOMBANK",
              "bankName": "NH TMCP Sài Gòn Thương Tín",
              "method": "VISA",
              "bankHotline": "1900 5555 88 - 08 526 6060",
              "transactionTime": 1740729822105,
              "successTime": 0,
              "merchantFee": 25425,
              "payerFee": 40527
          },
          {
              "transactionCode": "ALE00U1NH",
              "orderCode": "0001",
              "amount": 3000000,
              "currency": "VND",
              "buyerEmail": "hanguyen26109@gmail.com",
              "buyerPhone": "0963168911",
              "cardNumber": "412344-XXXX-0204",
              "buyerName": "Nguyen Van",
              "status": "000",
              "message": "Thành công",
              "reason": "Giao dịch thành công",
              "description": null,
              "installment": true,
              "is3D": false,
              "month": 4,
              "bankCode": "SACOMBANK",
              "bankName": "NH TMCP Sài Gòn Thương Tín",
              "method": "VISA",
              "bankHotline": "1900 5555 88 - 08 526 6060",
              "transactionTime": 1740729159024,
              "successTime": 1740729753875,
              "merchantFee": 25425,
              "payerFee": 40527
          },
          {
              "transactionCode": "ALE00U1MR",
              "orderCode": "0001",
              "amount": 3000000,
              "currency": "VND",
              "buyerEmail": "hanguyen26109@gmail.com",
              "buyerPhone": "0963168911",
              "cardNumber": "445653-XXXX-1005",
              "buyerName": "Nguyen Van",
              "status": "000",
              "message": "Thành công",
              "reason": "Giao dịch thành công",
              "description": null,
              "installment": true,
              "is3D": false,
              "month": 4,
              "bankCode": "SACOMBANK",
              "bankName": "NH TMCP Sài Gòn Thương Tín",
              "method": "VISA",
              "bankHotline": "1900 5555 88 - 08 526 6060",
              "transactionTime": 1740726321177,
              "successTime": 1740726324022,
              "merchantFee": 25425,
              "payerFee": 40527
          },
          {
              "transactionCode": "ALE00U1ME",
              "orderCode": "ORD_1740723167617",
              "amount": 3000000,
              "currency": "VND",
              "buyerEmail": "testalepay@yopmail.com",
              "buyerPhone": "0912880705",
              "cardNumber": "445653-XXXX-1005",
              "buyerName": "Nguyen Van",
              "status": "000",
              "message": "Thành công",
              "reason": "Giao dịch thành công",
              "description": null,
              "installment": true,
              "is3D": false,
              "month": 3,
              "bankCode": "SACOMBANK",
              "bankName": "NH TMCP Sài Gòn Thương Tín",
              "method": "VISA",
              "bankHotline": "1900 5555 88 - 08 526 6060",
              "transactionTime": 1740723211390,
              "successTime": 1740723214393,
              "merchantFee": 15511,
              "payerFee": 82136
          }
      ]
  }