Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Giới thiệu
Tính năng kiếm tiền cho phép bạn hoàn tiền cho nhà phát triển đối với "giao dịch mua". Giả sử bạn là một nhà mạng di động và bạn cung cấp cho nhà phát triển một API thanh toán để tính phí người đăng ký di động khi họ mua một ứng dụng hoặc nội dung trong ứng dụng. Mỗi lần người đăng ký sử dụng API để mua hàng, đó là một giao dịch mua.
Giao dịch mua có thể dẫn đến việc hoàn tiền. Ví dụ: nội dung có thể không được phân phối hoặc bên thứ ba không hài lòng với giao dịch mua. Trong những trường hợp đó, nhà phát triển sẽ hoàn tiền cho bên thứ ba. Tính năng kiếm tiền cho phép bạn hoàn tiền tương ứng. Điều này đặc biệt phù hợp với các kế hoạch chia sẻ doanh thu.
Giả sử nhà phát triển đã hoàn tiền cho người đăng ký trên thiết bị di động đã mua một gói chia sẻ doanh thu cho sản phẩm API của bạn. Giả sử kế hoạch quy định rằng nhà phát triển sẽ nhận được 70% giá ròng/giá gộp của giao dịch mua. Khi đăng khoản tiền hoàn lại, bạn sẽ huỷ giao dịch mua. Tức là bạn sẽ khấu trừ 70% khoản thanh toán phải trả cho nhà phát triển trong tháng áp dụng khoản tiền hoàn lại (tháng này có thể khác với tháng diễn ra giao dịch mua thực tế).
Đăng khoản tiền hoàn lại bằng giao diện người dùng Edge cổ điển (chỉ dành cho Edge cho Đám mây riêng tư)
Bạn có thể hoàn tiền cho mọi giao dịch mua "thành công", tức là giao dịch mà API đã tính phí thành công cho bên thứ ba và bạn chưa hoàn tiền toàn bộ. Việc đăng khoản tiền hoàn lại sẽ tạo ra một giao dịch hoàn tiền có mã giao dịch mẹ, trong đó mã giao dịch là mã của giao dịch mua.
Bạn có thể hoàn lại toàn bộ số tiền của giao dịch mua ban đầu hoặc hoàn lại một phần số tiền. Bạn cũng có thể đăng nhiều khoản hoàn tiền một phần, nhưng tổng số tiền hoàn lại không được lớn hơn số tiền mua ban đầu.
Cách đăng khoản tiền hoàn lại:
- Trên thẻ Kiếm tiền, hãy chọn Hoàn tiền.

Thao tác này sẽ mở trang Hoàn tiền.

- Trong trình đơn thả xuống Tháng thanh toán, hãy chọn tháng mà giao dịch mua diễn ra. Sau đó, hãy nhấp vào + Hoàn tiền.
Thẻ này hiển thị danh sách tất cả giao dịch mua thành công trong tháng đã chọn.

Bạn có thể lọc danh sách hoàn tiền theo tên nhà phát triển hoặc bằng cách tìm kiếm giao dịch thực tế.
Để lọc theo nhà phát triển, hãy chọn nhà phát triển trong trình đơn thả xuống Nhà phát triển. Thao tác này chỉ hiển thị danh sách các giao dịch liên quan đến nhà phát triển đã chọn.

Để lọc theo mã giao dịch, hãy nhập mã giao dịch của giao dịch mua ban đầu mà bạn muốn hoàn tiền. Thao tác này sẽ trả về giao dịch cho mã nhận dạng đó.

- Đánh dấu vào hộp Chọn trong(các) hàng tương ứng với(các) giao dịch mà bạn muốn hoàn tiền.
- Chọn Tổng số hoặc Một phần trong trình đơn thả xuống Loại.
Nếu bạn chọn Tổng, toàn bộ số tiền của giao dịch mua sẽ được hoàn lại. Nếu bạn chọn Một phần, một phần số tiền của giao dịch mua sẽ được hoàn lại.
Nếu bạn chọn Hoàn tiền một phần, hãy nhập số tiền hoàn lại một phần vào trường Số tiền. Bạn chỉ có thể hoàn tiền tối đa bằng tổng số tiền của giao dịch mua. Nếu đã đăng một khoản hoàn tiền một phần, bạn chỉ có thể nhập số tiền tối đa bằng số tiền còn lại của giao dịch mua. Ngoài ra, nếu giao dịch mua ban đầu có cả giá gộp và giá thuần, bạn cũng cần nêu rõ số tiền hoàn lại một phần mà bạn muốn hoàn là giá gộp hay giá thuần.

- Nhấp vào Lưu để xử lý việc hoàn tiền (hoặc nhấp vào Huỷ để huỷ).
Khoản tiền hoàn lại sẽ được ghi vào tháng của giao dịch mua ban đầu nếu tháng thanh toán vẫn đang mở, nếu không, khoản tiền hoàn lại sẽ được ghi vào ngày hiện tại.
Đối với giao dịch hoàn tiền một phần, khoản tiền hoàn lại sẽ được xử lý cho số tiền hoàn lại một phần và mọi khoản chia sẻ doanh thu sẽ được khấu trừ dựa trên tỷ lệ của số tiền hoàn lại một phần so với tổng số tiền. Trong ví dụ về việc hoàn tiền một phần ở trên, số tiền hoàn lại một phần là 0,50/1,12 = 45% giá gộp, do đó, 45% phần chia sẻ doanh thu của nhà phát triển sẽ bị khấu trừ.
Kiểm tra trong giao diện người dùng xem khoản tiền hoàn lại đã được xử lý hay chưa
Bạn có thể xác định xem khoản tiền hoàn lại đã được xử lý hay chưa bằng cách chọn tháng lập hoá đơn ở đầu trang Hoàn tiền. Đây là tháng mua hàng nếu tháng thanh toán vẫn đang mở hoặc tháng hiện tại nếu tháng thanh toán đã đóng. Thao tác này sẽ hiển thị danh sách tất cả các khoản tiền hoàn lại đã được đăng trong tháng.
Đăng yêu cầu hoàn tiền bằng API
Để đăng yêu cầu hoàn tiền, hãy gửi một yêu cầu POST đến /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions, trong đó {package_id} là thông tin nhận dạng của gói API mà yêu cầu hoàn tiền áp dụng.
Khi đưa ra yêu cầu, bạn cần chỉ định dưới dạng tham số truy vấn:
- Thông tin nhận dạng giao dịch mua hàng đang được hoàn tiền.
- Loại doanh thu (
GROSShoặcNET) của giao dịch mua. - Số tiền hoàn lại.
- Ghi chú mô tả lý do hoàn tiền.
Nếu muốn, bạn có thể xác định một gói API mà ứng dụng hoàn tiền áp dụng dưới dạng một tham số URL.
Hãy xem Chế độ cài đặt cấu hình hoàn tiền để biết danh sách đầy đủ các tham số URL mà bạn có thể chỉ định trong yêu cầu hoàn tiền.
Ví dụ: yêu cầu sau đây sẽ hoàn tiền cho một giao dịch mua. Số tiền hoàn lại bằng 50% tổng số tiền của giao dịch mua.
$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/refund-transactions?revenueType=GROSS&refundAmount=0.5&parentTxId=abf50909-2492-4bf5-8704-ade05f4d43b3&transactionNote=Refund for purchase transaction" \
-u email:password
Phản hồi sẽ có dạng như sau (chỉ một phần của phản hồi được hiển thị):
{ "application" : { ... }, "product" : [ { ... { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], ... }, "currency" : "USD", "developer" : { ... "legalName" : "DEV ONE", "name" : "Dev One", "organization" : { ... }, ... }, "endTime" : "2013-09-01 21:59:59", "environment" : "PROD", "euroExchangeRate" : 0.8123, "gbpExchangeRate" : 0.6910, "grossPrice" : 0.5, "id" : "61f7eb88-f8cc-4cda-afd8-4a61fba3dd33", "isRevOnGrossOrNet" : "NET", "isVirtualCurrency" : false, "notes" : "Refund for purchase transaction", "itemDesc" : "test application", "netPrice" : 0.4464, "orgRevenueShareAmount" : 0.1339, "parentId" : "abf50909-2492-4bf5-8704-ade05f4d43b3", "pkgId" : "myorg@@@payment", "pkgRatePlanProductName" : "Payment", ... }, "ratePlanLevel" : "STANDARD", "revenueShareAmount" : 0.3125, "startTime" : "2013-09-01 21:59:59", "status" : "SUCCESS", "tax" : 0.0536, "taxModel" : "UNDISCLOSED", "txProviderStatus" : "SUCCESS", "type" : "REFUND", "usdExchangeRate" : 1.0724, "utcEndTime" : "2013-09-01 21:59:59", "utcStartTime" : "2013-09-01 21:59:59" }
Chế độ cài đặt cấu hình hoàn tiền cho API
Bạn có thể chỉ định các tham số truy vấn sau đây trong yêu cầu hoàn tiền:
| Tên | Mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
monetizationPackageId |
Gói API mà khoản tiền hoàn lại áp dụng. |
Không áp dụng | Không |
parentTxId |
Giao dịch mua cần được hoàn tiền. |
Không áp dụng | Có |
revenueType |
Loại doanh thu ( |
Không áp dụng | Có |
refundAmount |
Số tiền hoàn lại. |
Không áp dụng | Có |
transactionNote |
Ghi chú bằng văn bản mô tả lý do hoàn tiền. |
Không áp dụng | Có |
Các bước tiếp theo
Tìm hiểu cách lên lịch các công việc liên quan đến việc kiếm tiền và các công việc được lên lịch tự động trong phần Lên lịch các công việc kiếm tiền.