Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Giới thiệu
Tính năng kiếm tiền cho phép bạn đăng khoản tiền hoàn lại cho nhà phát triển đối với các "giao dịch mua". Giả sử bạn là nhà cung cấp dịch vụ di động và bạn cung cấp cho nhà phát triển một API thanh toán để tính phí thuê bao di động cho giao dịch 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, đó sẽ là một giao dịch mua hàng.
Giao dịch mua có thể dẫn đến việc hoàn tiền. Ví dụ: nội dung có thể chưa đượ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 thực hiện một khoản tiền hoàn lại tương tự. Điều này đặc biệt phù hợp với các kế hoạch chia sẻ doanh thu.
Hãy tưởng tượng nhà phát triển hoàn tiền cho người đăng ký 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 này yêu cầu nhà phát triển nhận 70% giá ròng/tổng của giao dịch mua. Bằng việc đăng tiền hoàn lại, trên thực tế, bạn đảo ngược giao dịch mua, tức là bạn khấu trừ 70% khoản thanh toán mà nhà phát triển phải trả cho tháng áp dụng khoản tiền hoàn lại (tháng có thể khác với tháng thực hiện giao dịch mua hàng thực tế).
Đăng hoàn tiền bằng giao diện người dùng Classic Edge (chỉ dành cho Edge cho Đám mây riêng tư)
Bạn có thể đăng tiền hoàn lại cho bất kỳ giao dịch mua "thành công" nào, tức là khi API tính phí thành công cho bên thứ ba mà bạn chưa hoàn lại toàn bộ tiền. Việc đăng khoản tiền hoàn lại sẽ dẫn đến việc tạo một giao dịch hoàn tiền có mã giao dịch chính, trong đó mã giao dịch là mã của giao dịch mua hàng.
Bạn có thể đăng hoàn lại toàn bộ số tiền của giao dịch mua ban đầu hoặc một phần số tiền. Bạn cũng có thể đăng nhiều khoản tiền hoàn lại một phần nhưng tổng số tiền hoàn lại không được nhiều 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ở ra trang Hoàn tiền.
- Trong tháng thanh toán, hãy chọn tháng diễn ra giao dịch mua hàng trong trình đơn thả xuống. Sau đó, hãy nhấp vào + Hoàn tiền.
Thao tác này sẽ hiển thị danh sách tất cả giao dịch mua thành công cho 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 dành cho 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 của(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 số tiền thì tổng 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, thì một phần tiền của giao dịch mua sẽ được hoàn lại.
Nếu bạn chọ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 tổng số tiền của giao dịch mua. Nếu đã đăng một khoản tiền hoàn lại một phần, bạn chỉ có thể nhập số tiền tối đa là 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á tổng và giá ròng, bạn cũng cần cho biết số tiền từng phần mà bạn muốn hoàn lại là giá gộp hay giá ròng.
- Nhấp vào Lưu để xử lý khoản tiền hoàn lại (hoặc Huỷ để huỷ).
Nếu tháng thanh toán vẫn còn trong thời hạn của giao dịch mua ban đầu, thì khoản tiền hoàn lại sẽ được đăng vào tháng thanh toán, nếu không thì khoản tiền hoàn lại sẽ được đăng vào ngày hiện tại.
Đối với giao dịch hoàn tiền một phần, tiền hoàn lại sẽ được xử lý cho toàn bộ số tiền và mọi phần doanh thu chia sẻ sẽ được khấu trừ dựa trên tỷ lệ phần trăm của số tiền đó so với toàn bộ số tiền. Trong ví dụ về việc hoàn tiền một phần ở trên, số tiền một phần sẽ là 0,50/1,12 = 45% tổng giá, do đó, 45% phần doanh thu chia sẻ của nhà phát triển sẽ bị khấu trừ.
Kiểm tra trong giao diện người dùng để xem yêu cầu hoàn tiền đã đượ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 thanh toán ở đầu trang Hoàn tiền. Đây là tháng thực hiện giao dịch mua 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 khoản tiền hoàn lại bằng API
Để đăng khoản tiền hoàn lại, hãy gửi yêu cầu POST tới /organizations/{org_name}/monetization-packages/{package_id}/refund-transactions, trong đó {package_id} là giá trị nhận dạng gói API dùng để áp dụng khoản tiền hoàn lại.
Khi đưa ra yêu cầu, bạn cần chỉ định làm tham số truy vấn:
- Nhận dạng giao dịch mua hàng đượ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 sẽ áp dụng khoản tiền hoàn lại dưới dạng tham số URL.
Hãy xem phần 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 tiến hành hoàn tiền cho một giao dịch mua. Số tiền hoàn lại là 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ỉ hiển thị một phần nội dung của phản hồi):
{
"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 lại tiền:
| Tên | Nội dung mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
monetizationPackageId |
Gói API áp dụng khoản tiền hoàn lại. |
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 |
Một 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 cho các công việc liên quan đến hoạt động 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 cho công việc kiếm tiền.