1. Tạo giao dịch

- API path: /api/payment/v1/create

- Method: POST

- Mô tả: API do KLB Pay cung cấp dùng để tạo mới một giao dịch, kết quả trả về là mã QR.

Tham số trong Request Body

Key	Type	Require	Value
data	String	✓	Chứa dữ liệu đã được mã hóa

Các thông tin trường data lúc chưa mã hóa:

Key	Type	Require	Ý nghĩa
refTransactionId	String	✓	Mã giao dịch tham chiếu của đối tác
amount	Number	✓	Số tiền cần thu hộ
description	String	✓	Mô tả đơn hàng
bankAccountNo	String		Số tài khoản nhận tiền (hệ thống chọn tài khoản mặc định trong trường hợp null)
timeout	Number		Khoảng thời gian hết hạn thanh toán
title	String		Tiêu đề
language	String		Ngôn ngữ (mặc định Tiếng Việt)
customerInfo	Object		Thông tin khách hàng
successUrl	String		Đường dẫn điều hướng về khi giao dịch thành công
failUrl	String		Đường dẫn điều hướng về khi giao dịch thất bại
redirectAfter	Number		Thời gian thông báo kết quả giao dịch và bắt đầu điều hướng (đơn vị giây, mặc định 5s)

Các thông tin trong object customerInfo:

Key	Type	Require	Value
fullName	String	✓	Họ và tên khách hàng
email	String		Email của khách hàng
phone	String		Số điện thoại của khách hàng
address	String		Địa chỉ của khách hàng

Tham số trong Response Body

Key	Type	Value
code	Number	Mã lỗi
message	String	Mô tả thông tin mã lỗi
data	String	Chứa dữ liệu đã được mã hóa

Các thông tin trường data lúc chưa mã hóa:

Key	Type	Value
transactionId	String	Mã giao dịch
refTransactionId	String	Mã giao dịch liên kết
payLinkCode	String	Mã PayLink
timeout	Number	Thời gian timeout
url	String	đường dẫn đến Paylink
virtualAccount	String	Tài khoản ảo tạo ra khi tạo mới một giao dịch
description	String	Mô tả đơn hàng
amount	Number	Giá trị đơn hàng
qrCodeString	String	Giá trị trong QR code
status	Enum	Trạng thái đơn hàng
time	DateTime	Thời gian đặt hàng
accountName	String	Tài khoản người thụ hưởng

Ví dụ

• Request Mẫu
  • Request Body

        {
            "data": "OHOSrqRE77HHLCVOCO2QrHnMJqjmVe5AeC4rAIDBATaPjzkI2jNXpYRLGrPUyNqVrKgM8xM9NBotXMJ6YnqrhHR/tT6zSiov9uYvqVdIDoO1vVFNh44yF+IIdPr/9O45q4OYfJlQ++VpHrOlFOKpZHePYjfUZewDT3rWiWf80NQRVeHmHYTD7hGoQyidTrfvEr21KJEEHrfHq6IjPWE6pQ8b4OhUhdFXtJDVmZonVeR1g0myGXECo78xwqbWQH2FzH+o0b6CztkGYKqQ2pRbqqIuUjFmTjPAF2AOrXMauTVBilXzSVUCKUEfxyW2GRDCJvZu+3mIX/PYPelOtrp0Kvhb712r8rwJLtwh7X95f8wC4cdImm79PlHpNXwmOH8cwG/HNalvNJ3VABk87MI6+8o2XXqZtUMI/3Jgo3LZnVtrX90rn672/qifyhsMKtD/jPoPcvghLAbgQBZ3+UsNLBhmGLMglWqarYiBK72ZTGPhT1/PBtEhR5DegnZf4ij7Ab88K5Kc8FbfX7OQNQOwV9phAJI7IZdk5AUwVyxy2bbK62gxSYb1klcrnjW3vG8rZz0QAa4FodJREnHM9I/yLw=="
        }
  • Giá trị trường data trước khi encrypt:

        {
            "refTransactionId": "b5c7b604-fc03-44f1-b551-1dc6194783fa",
            "amount": 200000,
            "description": "Mo ta cho phien giao dich",
            "timeout": 17,
            "title": "Tieu de phien giao dich",
            "language": "VN",
            "customerInfo": {
                "fullName": "Nguyen Van A",
                "email": "vana2468@gmail.com",
                "phone": "0123456789",
                "address": "Viet Nam"
            },
            "successUrl": "https://hostname.com/path",
            "failUrl": "https://hostname.com/path",
            "redirectAfter": 60,
            "bankAccountId": "5f191ad4-7511-11ed-a1eb-0242ac120002"
        }
• Response mẫu
  • Response Data:

        {
            "code": 0,
            "message": "success",
            "data": "tdvx2H08/W4EGk7kfPvQZho4IBVrhoRcr58ma5zmIg0lT0SzYTjwCcOE9oeDvlZ26jJrQLTbgU12L5JtXBoE2To68R7VJTPHkLv4iaSQhjhn7orJlY4e1V5bj7RreIpd4ZscXBDRicyJlDK15izO/dAP+XLaoH+WgpMP/J6JAKNlaERto2TWlKrnANwgrN+Bz5cyuLINJwVAJt/xjEW7LwWFKc0+bVHXhNJJy7mBKzy/xOrLMEF/+ZkpOrSrgY/IC8B9OueKbwLMBv434VGAqrSmmteQFfGujwP8d+QRlfFPnnHkXc+Wg4tHI5UnrvxCtb1RTYeOMhfiCHT6//TuOauDmHyZUPvlaR6zpRTiqWQw7bydqiq8iTOgnZo91HCZHkPp/w1sO6XOTE3WjrJ5AkpcblJzWsmrpSXvPy8AT5lkMz2vmxENle/RHXpzw1TDP/D5PnhKbIrk4qfrriOYsBLKtuLTqe1OdMta18Ko1QQhwE+extT0CsPjgHrTQRlffI1WyU3qmsGZX2LCLZsig37HIU9pxKQvRyPbTfAGNW/OayD80ZbV50i5zLCmZMwiMu4LYGxaLo7yGJGfDEpM8zYziUH1B0GhFbfnrgRCMefJ4eSMpyqGwCPatERr/cjzagW4l7jvR2YuyszFVre6jKsdtEczmXp62GsLYT4XtIYAoKfgXKZoqQ4pnlh9BYJtLmuhF7xLjG4uPr3+l2ji9Q=="
        }
  • Gía trị trường data trước khi encrypt:

        {
            "transactionId": "6e115581-b7b9-403c-aed8-9ec406d9c6a0",
            "refTransactionId": "b5c7b604-fc03-44f1-b551-1dc6194783fa",
            "payLinkCode": "vBmkzd08",
            "timeout": 17,
            "url": "https://{{domain}}/paylink/4iokRjdq",
            "virtualAccount": "10092212062629153",
            "description": "Mo ta cho phien giao dich",
            "amount": 200000,
            "qrCodeString": "00020101021238610010A000000727013100069704520117100922120626291530208QRIBFTTA530370454062000005802VN62520848TT Don hang b5c7b604-fc03-44f1-b551-1dc6194783fa63040F82",
            "status": "CREATED",
            "time": "2022-12-06T11:31:13.643118",
            "accountName": "Test"
        }