API Liên kết thẻ

a. Tổng quan

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

- HTTP Request: POST <BASE_URL> /request-profile

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

Trường

Kiểu

Mô tả dữ liệu

tokenKey

String

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

id

String

ID của người dùng trên Merchant

firstName

String

Tên người dùng

lastName

String

Họ người dùng

street

String

Địa chỉ đường

city

String

Thành phố

state

String

Tỉnh

postalCode

String

Mã bưu chính

country

String

Quốc gia

email

String

Địa chỉ Email người dùng

phoneNumber

String

Số điện thoại của người dùng

callback

String

Đường dẫn callback

language

String

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

signature

String

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)

Trường

Kiểu

Mô tả dữ liệu

url

String

URL để user thực hiện liên kết thẻ

code

String

Mã lỗi. Xem chi tiết bảng mã lỗi

message

String

Mô tả lỗi

 

d. Khách hàng liên kết thẻ thành công Alepay sẽ chuyển hướng về Đường dẫn callback (request data)

Khi End User kết thúc quá trình liên kết thẻ trên Alepay, Alepay sẽ chuyển hướng về Đường dẫn callback mà Merchant đã cung cấp khi gọi API Liên kết thẻ và đồng thời Alepay sẽ callback về link webhook đã khai báo trên Alepay Merchant Xem tài liệu ở đây

. Dưới đây là mô tả các thông số Alepay sẽ nối vào đường dẫn callback.

- HTTP Request: GET <MERCHANT_CALLBACK_URL>

- Định dạng: <MERCHANT_CALLBACK_URL>?errorCode=000&id=XXXX&cancel=false

- Response:

Trường

Kiểu

Mô tả dữ liệu

errorCode

String

Mã lỗi (được mô tả trong mục Phụ lục 12.a)

id

String

ID của người dùng bên phía Merchant đã thực hiện liên kết thẻ

cancel

String

True : Người dùng hủy liên kết thẻ

False : Người dùng thực hiện xong quá trình liên kết thẻ

 

e. Demo API Liên kết thẻ

- Data Request:

   {
      "tokenKey": "63vhaCjfe96SZlBH1ma200yUPBraqH",
      "id":"Test",
      "firstName": "Nguyen",
      "lastName":"Van A",
      "street":"Test",
      "city": "HN",
      "state": "HN",
      "postalCode": "10000",
      "country": "VN",
      "email":"hanguyen261098@gmail.com",
      "phoneNumber":"0394028864",
      "callback":"https://webhook.site/02818f6d-6899-4886-9221-29ef09b02d61",
      "language":"vi",
      "signature":"4a46a2f3613a512a3f0df2d82d18b95b93e97b3184669127c250051cd4238829"
  }

- Data Response:

   {
      "code": "000",
      "message": "Thành công",
      "url": "https://alepay-v3-sandbox.nganluong.vn/checkout/vi/v3/cardlink/index/JZGgyaOygP7BI4VUcAmKuzXSSsOF8b5d"
  }