API Thanh toán Tokenization

a. Tổng quan

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

- HTTP Request: POST <BASE_URL> /request-tokenization-payment

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ả

customerToken

String

T

 

Token của end user Alepay cung cấp cho merchant khi liên kết thẻ

orderCode

String T   Mã đơn hàng
amount Double T   Giá trị của đơn hàng (Nếu currency là VND thì gửi lên amount làm tròn đến 1 VND)
installment Boolean T  

true : Giao dịch trả góp, 

false: Giao dịch thường

installmentTenor Double T  

Kỳ hạn trả góp

Bắt buộc nếu installment = true

bankCode String T  

Mã ngân hàng

Bắt buộc nếu installment = true

paymentMethod String T  

Loại thẻ cần nhập:

VISA / MASTERCARD / JCB

Bắt buộc nếu installment = true

currency String T   Loại tiền tệ
orderDescription String T   Mô tả đơn hàng (Không bao gồm các ký tự đặc biệt, sẽ tự động loại bỏ các kí tự đặc biệt ra khỏi mô tả đơn hàng)
returnUrl String T   URL callback khi thành công
cancelUrl String T   URL callback khi thất bại
paymentHours String T   Thời gian thanh toán cho phép
promotionCode String T   Mã chương trình khuyến mại
language String F vi

Ngôn ngữ:

en: tiếng anh

vi: tiếng việt


checksum = SHA-256 (customerToken + checksumKey)

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

Sẽ có 2 bước response cho yêu cầu thanh toán:

  • Bước 1: Response URL redirect tới màn hình 3Ds xác nhận thanh toán sau khi KH Merchant gọi yêu cầu thanh toán.

  • Bước 2: Response kết quả thanh toán sau khi KH Merchant xác thực thanh toán.

Url xác thực thanh toán:

Trường

Kiểu

Mô tả dữ liệu

linkRedirect3D

String

URL redirect tới màn hình 3Ds để chủ thẻ xác thực thanh toán

transactionCode

String

Mã giao dịch Alepay


Kết quả thanh toán:

Merchant cung cấp link “returnURL” cho Alepay, Alepay thực hiện callback kết quả thanh toán cho Merchant. Dưới đây là các thông số kỹ thuật Alepay trả về Merchant:

Trường

Kiểu

Mô tả dữ liệu

code

String

Mã lỗi

transactionCode

String

Mã giao dịch Alepay

orderCode

String

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

cancel

String

Trạng thái giao dịch

True: Người mua cancel giao dịch, False: người mua thực hiện xong quá trình thanh toán.

checksum

String

Check sum cho data 

checksum = SHA-256 (code + transactionCode + orderCode+ ChecksumKey)


  • Lưu ý: URL callback về cho Merchant sẽ có dạng như sau: 

<MERCHANT_CALLBACK_URL>?code =XXXX &cancel=XXXX &transactionCode=XXXX& orderCode =XXXX&checksum=XXXX