III. Giải pháp tích hợp thanh toán
1. Giải Pháp Thanh Toán PayME Link
1.1. Giới thiệu:
Là giải pháp thanh toán tạo ra link thanh toán của PayME áp dụng trên nhiều nền tảng khác nhau như desktop website, mobile website, web in app
1.2. Sơ đồ tích hợp:
| Bước | Tên bước | Diễn giải | Thực hiện |
|---|---|---|---|
| 1. | End-User chooses a payment method | End-User chọn PTTT của PayME có hỗ trợ ở ứng dụng của Merchant | End-User |
| 2. | Submit a request to create a payment order | Merchant kết nối đến PayME Server khởi tạo đơn hang thanh toán | Merchant |
| 3. | Return payment order information | PayME khơi tạo và trả về cho Merchant link thanh toán đơn hang tương ứng với PTTT và số tiền Merchant đã gửi sang | PayME |
| 4. | Open the payment link returned by PayME | Từ Client Merchant mở link do PayME trả về cho khách hang thực hiện thanh toán | Merchant |
| 5. | Customers make payment on PayME Link | End-User xem thông tin đơn và thực hiện xác nhân giao dịch | End-User |
| 6. | Processing order payment transactions | PayME ghi nhận kết quả giao dịch thanh toán thành công hay thất bại. | PayME |
| 7. | Return transaction results | PayME xử lý giao dịch nếu thành công sẽ redirect về lại web của MC đồng thời IPN đến Server Merchant để ghi nhân kết quả giao dịch | PayME |
| 8. | Show order results | Merchant hiển thị kết quả đơn thanh toán | Merchant |
1.3. Danh sách API tích hợp
| Tên API | Endpoint | Hướng gọi | Mô tả |
|---|---|---|---|
| Tạo đơn hàng | payment/web | MC->PayME | Sử dụng khởi tạo đơn hàng |
| Callback | ipn url mc | PayME->MC | PayME gọi lại Merchant thông báo kết quả đơn hàng |
| Truy vấn đơn hàng | payment/query | MC->PayME | Merchant chủ động truy vấn thông tin đơn hàng |
| Hoàn tiền | payment/refund | MC->PayME | Merchant yêu cầu PayME hoàn tiền cho khách hàng |
1.4. Hướng dẫn tích hợp
Ở Merchant Client khi khách hàng thao tác thanh toán đơn hang cho phép chọn các PTTT do PayME cung cấp
Sau khi End-user đồng ý thanh toán Merchant Client gửi thông tin đến Merchant Server, Merchant Server gửi yêu cầu tạo đơn thanh toán đến API
payment/webcủa PayME Server để tạo đơn thanh toán.Merchatn Client mở link thanh toán do PayME trả về để khách hàng thực hiện thanh toán, Merchant mở link bằng brower để khách hàng thực hiện thanh toán
PayME Server callback IPN đến Merchant Server
Khi End-user hoàn thành thanh toán ở PayME, nếu thành công PayME Server sẽ trả về (callback/notify) thông tin trạng thái thanh toán cho Merchant Server theo ipnUrl đã gửi sang lúc tạo đơn.
PayME Client redirect về Merchant Site
PayME Client chuyển hướng (redirect) về Merchant Site nếu giáo dịch thành công sẽ redirect đến redirectUrl nếu thất bại sẽ redirect đến failedUrl tương ứng lúc tạo đơn thành toán.
Nếu quá thời gian cho phép End-User thao tác nhưng chưa có kết quả callback ipn đến merchant server có thể chủ động gọi api payment/query để kiểm tra trạng thái đơn thanh toán
2. Giải Pháp Thanh Toán QR:
2.1. Giới thiệu
Là giải pháp hiển thị QRCode trên ứng dụng của Merchant để End-User sử dụng ứng dụng của nhà phát hành hoặc hỗ trợ PTTT thực hiện scan để thanh toán.
2.2. Sơ đồ tích hợp:
| Bước | Tên bước | Diễn giải | Thực hiện |
|---|---|---|---|
| 1. | End-User chooses a payment method | End-User chọn PTTT của PayME có hỗ trợ ở ứng dụng của Merchant | End-User |
| 2. | Submit a request to create a payment order | Merchant kết nối đến PayME Server khởi tạo đơn hang thanh toán | Merchant |
| 3. | Return payment order information | PayME khơi tạo và trả về cho qrContent tương ứng với PTTT và số tiền Merchant đã gửi sang | PayME |
| 4. | Merchant client displays QRCode | Client Merchant tạo QRCode với nội dung là QRContent để khách hàng thực hiện thanh toán | Merchant |
| 5. | Scan the QRCode with the issuer's app or a camera that supports QRCode scanning | End-User dùng ứng dụng của đối tác phát hành hỗ trợ PTTT để scan QRCode ở ứng dụng của Merchant, Với các QRContent là dạng link có thể sử dụng camera có hỗ trợ qrcode để mở link thanh toán trên mobile để tiếp tục thanh toán | End-User |
| 6. | End-User confirms payment on issuer's app | End-User kiểm tra thông tin đơn và xác nhận đồng ý thanh toán | End-User |
| 7. | Processing order payment transactions | PayME ghi nhận kết quả giao dịch thanh toán thành công hay thất bại. | PayME |
| 8. | Return transaction results | PayME xử lý giao dịch nếu thành công sẽ redirect về lại web của MC đồng thời IPN đến Server Merchant để ghi nhân kết quả giao dịch | PayME |
| 9. | Show order results | Merchant hiển thị kết quả đơn thanh toán | Merchant |
2.3. Danh sách API tích hợp:
| Tên API | Endpoint | Hướng gọi | Mô tả |
|---|---|---|---|
| Thanh toán QR | payment/direct | MC->PayME | Sử dụng tạo QRCode thanh toán |
| Callback | ipn url mc | PayME->MC | PayME gọi lại Merchant thông báo kết quả đơn thanh toán |
| Truy vấn đơn | payment/query | MC->PayME | Merchant chủ động truy vấn thông tin đơn thanh toán |
2.4. Hướng dẫn tích hợp
Ở Merchant Client khi khách hàng thao tác thanh toán đơn hang cho phép chọn các PTTT do PayME cung cấp
Sau khi End-user đồng ý thanh toán Merchant Client gửi thông tin đến Merchant Server, Merchant Server gửi yêu cầu tạo đơn thanh toán đến API Thanh toán QR (payment/direct) của PayME Server.
Merchatn Client dùng QRContent để tạo mã QR hiển thị cho End-User.
Merchant có thể tự dùng thư viện của code của Merchant để tạo mã QR hoặc có thể sử dụng link của PayME cung cấp có dạng:
https://t.payme.vn/qr?t=QRContent&w=150&h=150. Trong đó:
t: QRcontentw: chiều rộng của hình qrh: chiều cao của hình qr
PayME Server callback IPN đến Merchant Server
Khi End-user hoàn thành thanh toán ở PayME, nếu thành công PayME Server sẽ trả về (callback/notify) thông tin trạng thái thanh toán cho Merchant Server theo ipnUrl đã gửi sang lúc tạo đơn.
PayME Client redirect về Merchant Site
PayME Client chuyển hướng (redirect) về Merchant Site nếu giáo dịch thành công sẽ redirect đến redirectUrl nếu thất bại sẽ redirect đến failedUrl tương ứng lúc tạo đơn thành toán.
Nếu quá thời gian cho phép End-User thao tác nhưng chưa có kết quả callback ipn đến merchant server có thể chủ động gọi api payment/query để kiểm tra trạng thái đơn thanh toán
3. Giải Pháp API Chi Hộ
3.1. Giới thiệu:
Merchant có thể tạo lệnh chi tiền từ nguồn là số dư merchant/ ví doanh nghiệp đến ví PayME/tài khoản ngân hàng/thẻ ATM.
Giải pháp chi hộ cung cấp giải pháp chi tiền đơn giản, nhanh chóng, nhận tiền tức thời 24/7. Lịch sử giao dịch sẽ được lưu lại, đảm bảo tra cứu hiệu quả, an toàn và bảo mật.
3.2. Sơ đồ tích hợp:
| Bước | Tên bước | Diễn giải | Thực hiện |
|---|---|---|---|
| 1. | Request a money transfer | Merchant Owner thực hiện tạo lệnh yêu cầu chi | Merchant Owner |
| 2. | Create a money transfer order | Merchant Server kết nối đến PayME Server khởi tạo yêu cầu chi | Merchant |
| 3. | Authentication required? | Nếu yêu cầu Merchant cài đặt yêu cầu xác thực khi chi, PayME sẽ trả về verifyLink. Nếu không cần xác thực sẽ đến bước 7 | PayME |
| 4. | Merchant client opens verifyLink | Merchant Client mở verifyLink của PayME trả về | Merchant |
| 5. | Enter verifyCode at verifyLink | Merchant Owner nhập verifyCode là OTP hoặc mật khẩu giao dịch để xác nhận đồng ý chi ở verifyLink | Merchant Owner |
| 6. | Confirm transfer agreement | Merchant Owner bấm đồng ý để tiến hành chi | Merchant Owner |
| 7. | Make money transfer | Nếu verifyCode hợp lệ, PayME sẽ tiến hành chi đến tài khoản nhận ở lệnh yêu cầu chi | PayME |
| 8. | Return transaction results | PayME xử lý giao dịch chi và IPN đến Server Merchant để ghi nhân kết quả giao dịch chi | PayME |
| 9. | Show order results | Merchant hiển thị kết quả giao dịch chi | Merchant |
3.3. Danh sách API tích hợp
| Tên API | Endpoint | Hướng gọi | Mô tả |
|---|---|---|---|
| Tạo yêu cầu chi | pobo/transfer | MC->PayME | Sử dụng tạo yêu cầu chi |
| Callback | ipn url mc | PayME->MC | PayME gọi lại Merchant thông báo kết quả |
| Truy vấn chi | pobo/query | MC->PayME | Merchant chủ động truy vấn kết quả lệnh chi |
| Thực hiện lại lệnh chi | pobo/retry | MC->PayME | Thực hiện chi lệnh yêu cầu |
| Hủy chi | pobo/cancel | MC->PayME | Hủy lệnh chi |
3.4. Hướng dẫn tích hợp
Ở Merchant Client cho phép lập yêu cầu chi để xác định số tiền cần chi và tài khoản nhận.
Sau khi Merchant Owner đồng ý chi Merchant Client gửi thông tin đến Merchant Server, Merchant Server gửi yêu cầu tạo yêu cầu chi đến api pobo/transfer của PayME Server để tạo đơn thanh toán. Nếu nguồn chi sử dụng chứng thực là google authen hoặc token có thể gửi kèm ở tham số verifyCode để xác thực chi ngay.
Trong trường hợp PayME có trả về verifyLink, Merchant Client mở verifyLink do PayME trả về để khách hàng thực hiện nhập verifyCode .Trường hợp Merchant không đủ số dư thực hiện lệnh chi có thể trực tiếp tực hiện nạp thêm từ verifyLink.
PayME Server callback IPN đến Merchant Server
Nếu verifyCode hợp lệ sẽ tiến hành thực hiện lệnh chi và (callback/notify) thông tin kết quả chi đến Merchant Server theo ipnUrl đã gửi sang lúc yêu cầu chi.
Nếu quá thời gian cho phép nhưng chưa có kết quả callback ipn đến merchant server có thể chủ động gọi api pobo/query để kiểm tra trạng thái lệnh chi.
Thực hiện lại lệnh chi thất bại
Với các lênh chi thất bại do lỗi trong quá trình chi merchant có thể yêu cầu thực hiện lại lệnh chi bằng cách chủ động gọi api pobo/retry.
Với các lênh chi thất bại hoặc lệnh chi chưa nhập verifyCode merchant có thể yêu cầu hủy lệnh chi bằng cách chủ động gọi api pobo/cancel.
4. Giải Pháp Thanh Toán SDK
4.1. Giới thiệu:
Merchant có thể tạo và thanh toán đơn hàng cho User bằng số dư Ví PayME của User thông qua số Phone (số Phone này phải được liên kết ví payME trước đó)
4.2. Giải pháp thanh toán:
| Bước | Tên bước | Diễn giải | Thực hiện |
|---|---|---|---|
| 1. | Kiểm tra số dư ví khách hàng | Merchant kiểm tra số dư ví của User bằng số phone đã liên kết Ví | Merchant |
| 2. | Tạo đơn hàng thanh toán | Merchant tạo đơn hàng thanh toán | Merchant |
4.3. Danh sách API tích hợp
| Tên API | Endpoint | Hướng gọi | Mô tả |
|---|---|---|---|
| Kiểm tra số dư | ewallet/balance | MC->PayME | Sử dụng để kiểm tra số dư Ví |
| Thanh toán | ewallet/pay | MC->PayME | Sử dụng để tạo yêu cầu thanh toán |