Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Pengantar
Monetisasi memungkinkan Anda memposting pengembalian dana kepada developer untuk "transaksi pembelian". Misalkan Anda adalah operator seluler dan Anda menawarkan API pembayaran kepada developer untuk menagih pelanggan seluler atas pembelian aplikasi atau konten dalam aplikasi. Setiap kali pelanggan menggunakan API untuk melakukan pembelian, itu adalah transaksi pembelian.
Transaksi pembelian dapat menghasilkan pengembalian dana. Misalnya, konten mungkin tidak dikirim, atau pihak ketiga tidak puas dengan pembelian tersebut. Dalam kasus tersebut, developer mengeluarkan pengembalian dana kepada pihak ketiga. Monetisasi memungkinkan Anda melakukan pengembalian dana yang serupa. Hal ini terutama relevan dengan rencana pembagian keuntungan.
Bayangkan developer yang menerbitkan pengembalian dana kepada pelanggan seluler membeli paket pembagian keuntungan untuk produk API Anda. Misalkan rencana tersebut mengharuskan developer menerima 70% dari harga bersih/kotor transaksi pembelian. Dengan memposting pengembalian dana, Anda pada dasarnya membatalkan transaksi pembelian, yaitu Anda memotong 70% dari pembayaran yang harus dibayarkan kepada developer untuk bulan saat pengembalian dana diterapkan (bulan tersebut mungkin berbeda dengan bulan saat transaksi pembelian sebenarnya terjadi).
Memposting pengembalian dana menggunakan UI Edge Klasik (khusus Edge untuk Private Cloud)
Anda dapat memposting pengembalian dana untuk transaksi pembelian yang "berhasil", yaitu saat API berhasil menagih pihak ketiga dan Anda belum mengeluarkan pengembalian dana penuh untuk transaksi tersebut. Memposting pengembalian dana akan menghasilkan pembuatan transaksi pengembalian dana dengan ID transaksi induk, dengan ID transaksi adalah ID transaksi pembelian.
Anda dapat memposting pengembalian dana untuk jumlah penuh transaksi pembelian asli atau untuk jumlah sebagian. Anda juga dapat memposting beberapa pengembalian dana sebagian, tetapi jumlah total pengembalian dana tidak boleh lebih besar dari jumlah pembelian awal.
Untuk memposting pengembalian dana:
- Di tab Monetisasi, pilih Pengembalian dana.

Tindakan ini akan membuka halaman Pengembalian dana.

- Di menu drop-down Bulan Penagihan, pilih bulan saat transaksi pembelian
terjadi. Kemudian, klik + Pengembalian dana.
Bagian ini menampilkan daftar semua transaksi pembelian yang berhasil untuk bulan yang dipilih.

Anda dapat memfilter daftar pengembalian dana menurut nama developer atau dengan menelusuri transaksi sebenarnya.
Untuk memfilter menurut developer, pilih developer dari menu drop-down Developer. Bagian ini menampilkan daftar transaksi yang hanya terkait dengan developer yang dipilih.

Untuk memfilter menurut ID transaksi, masukkan ID transaksi pembelian asli yang ingin Anda kembalikan dananya. Tindakan ini akan menampilkan transaksi untuk ID tersebut.

- Centang kotak Pilih di baris untuk transaksi yang ingin Anda kembalikan dananya.
- Pilih Total atau Sebagian di menu drop-down Jenis.
Jika Anda memilih Total, jumlah total pembelian akan dikembalikan dananya. Jika Anda memilih Sebagian, sebagian jumlah pembelian akan dikembalikan.
Jika Anda memilih Sebagian, masukkan jumlah pengembalian dana sebagian di kolom Jumlah. Anda hanya dapat mengembalikan dana hingga jumlah total pembelian. Jika telah memposting pengembalian dana sebagian, Anda hanya dapat memasukkan jumlah hingga jumlah yang tersisa pada pembelian. Selain itu, jika transaksi pembelian asli memiliki harga kotor dan bersih, Anda juga harus menyatakan apakah jumlah sebagian yang ingin Anda kembalikan dananya adalah jumlah kotor atau bersih.

- Klik Simpan untuk memproses pengembalian dana (atau Batal untuk membatalkan).
Pengembalian dana diposting ke bulan pembelian asli jika bulan penagihan masih berlaku, atau pengembalian dana diposting ke tanggal saat ini.
Untuk pengembalian dana sebagian, pengembalian dana diproses untuk jumlah sebagian dan pembagian keuntungan dipotong berdasarkan proporsi jumlah sebagian terhadap jumlah penuh. Dalam contoh pengembalian dana sebagian di atas, jumlah sebagian adalah 0,50/1,12 = 45% dari harga kotor, sehingga 45% dari pembagian keuntungan developer akan dipotong.
Memeriksa di UI apakah pengembalian dana telah diproses
Anda dapat menentukan apakah pengembalian dana telah diproses dengan memilih bulan penagihan di bagian atas halaman Pengembalian dana. Ini adalah bulan pembelian jika bulan penagihan masih terbuka, atau bulan saat ini jika bulan penagihan sudah ditutup. Tab ini menampilkan daftar semua pengembalian dana yang telah diposting pada bulan tersebut.
Memposting pengembalian dana menggunakan API
Untuk memposting pengembalian dana, kirim permintaan POST ke
/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions,
dengan {package_id} adalah identifikasi paket API yang pengembalian dananya
berlaku.
Saat mengirimkan permintaan, Anda harus menentukan sebagai parameter kueri:
- Identifikasi transaksi pembelian yang sedang dikembalikan dananya.
- Jenis pendapatan (
GROSSatauNET) transaksi pembelian. - Jumlah pengembalian dana.
- Catatan yang menjelaskan alasan pengembalian dana.
Secara opsional, Anda dapat mengidentifikasi sebagai parameter URL paket API yang menerapkan pengembalian dana.
Lihat Setelan konfigurasi pengembalian dana untuk mengetahui daftar lengkap parameter URL yang dapat Anda tentukan dalam permintaan pengembalian dana.
Misalnya, permintaan berikut akan mengeluarkan pengembalian dana untuk transaksi pembelian. Jumlah pengembalian dana adalah 50% dari jumlah kotor transaksi pembelian.
$ 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
Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):
{ "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" }
Setelan konfigurasi pengembalian dana untuk API
Parameter kueri berikut dapat ditentukan dalam permintaan pengembalian dana:
| Nama | Deskripsi | Default | Wajib? |
|---|---|---|---|
monetizationPackageId |
Paket API yang pengembalian dananya berlaku. |
T/A | Tidak |
parentTxId |
Transaksi pembelian yang akan dikembalikan dananya. |
T/A | Ya |
revenueType |
Jenis pendapatan ( |
T/A | Ya |
refundAmount |
Jumlah pengembalian dana. |
T/A | Ya |
transactionNote |
Catatan teks yang menjelaskan alasan pengembalian dana. |
T/A | Ya |
Langkah berikutnya
Pelajari cara menjadwalkan tugas terkait monetisasi dan tugas yang dijadwalkan secara otomatis di Menjadwalkan tugas monetisasi.