API Danh sách kỳ hạn trả góp

a. Tổng quan

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

- HTTP Request: POST <BASE_URL> /get-installment-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

amount

Double

T

  

Số tiền thanh toán trả góp (Nếu currencyCode là VND thì gửi lên amount làm tròn đến 1 VND)

currencyCode

String

T

  

Mã tiền tệ

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

message

String

Mô tả lỗi

data

Array

Danh sách thông tin cấu hình trả góp

data là một danh sách các kỳ thanh toán và phí tương ứng. Mỗi kỳ thanh toán sẽ bao gồm các trường sau:

Trường

Kiểu

Mô tả dữ liệu

bankCode

String

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

bankName

String

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

paymentMethods

Array

Danh sách phương thức thanh toán Visa/ Master/…

Tham số paymentMethods là một mảng danh sách các phương thức thanh toán mà ngân hàng đó hỗ trợ và các kỳ thanh toán tương ứng với phương thức thanh toán đó, các trường được mô tả như sau:

Tên trường

Định dạng

Mô tả

paymentMethod

String

Phương thức thanh toán

periods

Array

Danh sách kỳ thanh toán

Tên trường

Định dạng

Mô tả

month

Double

Kỳ hạn trả góp

feeId

Long

Mã phí
minAmount Double Số tiền tối thiểu của kỳ thanh toán
amountFee Double

Tổng phí trả góp người mua phải trả

amountFee = (amount*payerPercentFee + payerFlatFee)/(1-payerInstallmentPercentFee-payerPercentFee) + (amount*payerInstallmentPercentFee+payerInstallmentFlatFee)/(1-payerInstallmentPercentFee-payerPercentFee)
amountFinal String

Tổng tiền khách hàng phải trả

amountFinal = amount + amountFee
amountByMonth String Số tiền phải trả mỗi tháng

 

 

 payerFlatFee Double

Phí cố định phải trả

 

 

 payerPercentFee Double

% phí cố định phải trả

 

 

payerInstallmentFlatFee

    Double

Phí chuyển đổi trả góp
    payerInstallmentPercentFee Double  % phí chuyển đổi trả góp
    currency String Mã tiền tệ
 

 

d. Demo API

- Data Request:

  {
      "amount": 3000000,
      "currencyCode": "VND",
      "signature": "07f54d0935e12da04047642d2fde56f624af43c84718f67a7236921021c779cc",
      "tokenKey": "SI85PMt00k9SfmIbupQinvHVPCHYUd"
  }

- Data Response:

  {
      "code": "000",
      "message": "Thành công",
      "data": [
          {
              "bankCode": "SACOMBANK",
              "bankName": "NH TMCP Sài Gòn Thương Tín",
              "paymentMethods": [
                  {
                      "paymentMethod": "JCB",
                      "periods": [
                          {
                              "month": 3,
                              "feeId": 690405,
                              "minAmount": 3000000,
                              "amountFee": 0,
                              "amountFinal": 3000000,
                              "amountByMonth": 1000000,
                              "payerFlatFee": 0,
                              "payerPercentFee": 0,
                              "payerInstallmentFlatFee": 0,
                              "payerInstallmentPercentFee": 0,
                              "currency": "VND"
                          }
                      ]
                  },
                  {
                      "paymentMethod": "VISA",
                      "periods": [
                          {
                              "month": 3,
                              "feeId": 690398,
                              "minAmount": 3000000,
                              "amountFee": 0,
                              "amountFinal": 3000000,
                              "amountByMonth": 1000000,
                              "payerFlatFee": 0,
                              "payerPercentFee": 0,
                              "payerInstallmentFlatFee": 0,
                              "payerInstallmentPercentFee": 0,
                              "currency": "VND"
                          }
                      ]
                  },
                  {
                      "paymentMethod": "MASTERCARD",
                      "periods": [
                          {
                              "month": 3,
                              "feeId": 690391,
                              "minAmount": 3000000,
                              "amountFee": 0,
                              "amountFinal": 3000000,
                              "amountByMonth": 1000000,
                              "payerFlatFee": 0,
                              "payerPercentFee": 0,
                              "payerInstallmentFlatFee": 0,
                              "payerInstallmentPercentFee": 0,
                              "currency": "VND"
                          }
                      ]
                  }
              ]
          }
      ]
  }