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 pengembang untuk menagih pelanggan seluler atas pembelian aplikasi atau konten di dalam aplikasi. Setiap kali pelanggan menggunakan API melakukan pembelian, ini adalah transaksi pembelian.
Transaksi pembelian dapat menyebabkan pengembalian dana. Misalnya, konten mungkin tidak terkirim, atau pihak ketiga tidak puas dengan pembelian tersebut. Dalam kasus tersebut, developer memberikan pengembalian dana ke pihak ketiga. Monetisasi memungkinkan Anda melakukan pengembalian dana yang setara. Ini adalah terutama yang berkaitan dengan rencana pembagian keuntungan.
Bayangkan developer yang memberikan pengembalian dana kepada pelanggan seluler membeli pendapatan berbagi paket untuk produk API Anda. Misalkan rencana meminta developer untuk menerima 70% dari harga bersih/kotor dari transaksi pembelian. Dengan memposting pengembalian dana, Anda, pada dasarnya, membatalkan transaksi pembelian, yaitu, Anda memotong 70% dari pembayaran yang harus dibayar pengembang untuk bulan tersebut kapan pengembalian dana diterapkan (bulan mungkin berbeda dengan bulan saat pengembalian dana terjadi).
Memposting pengembalian dana menggunakan UI Klasik Edge (khusus Edge untuk Private Cloud)
Anda dapat memposting pengembalian dana untuk setiap iklan yang "berhasil" transaksi pembelian, yaitu di mana API berhasil ditagih kepada pihak ketiga dan yang belum Anda keluarkan tagihannya pengembalian dana. Memposting pengembalian dana menyebabkan pembuatan transaksi pengembalian dana dengan orang tua ID transaksi, dengan ID transaksi adalah ID transaksi pembelian.
Anda dapat memposting pengembalian dana sebesar jumlah penuh dari transaksi pembelian awal atau untuk jumlah parsial. Anda juga dapat memposting beberapa pengembalian dana sebagian, tetapi jumlah total pengembalian dana tidak boleh lebih dari jumlah pembelian awal.
Untuk memposting pengembalian dana:
- Pada tab Monetisasi, pilih Pengembalian Dana.
Tindakan ini akan membuka halaman Pengembalian dana.
- Pada menu drop-down Bulan Penagihan, pilih bulan untuk transaksi pembelian
berlangsung. Lalu klik + Pengembalian dana.
Ini menampilkan daftar semua transaksi pembelian yang berhasil untuk item yang dipilih bulan.
Anda dapat memfilter daftar pengembalian dana menurut nama developer atau dengan menelusuri transaksi.
Untuk memfilter menurut developer, pilih developer dari menu drop-down Developer. Ini hanya menampilkan daftar transaksi yang terkait dengan pengembang yang dipilih.
Untuk memfilter menurut ID transaksi, masukkan ID transaksi pembelian awal yang Anda ingin pengembalian dana. 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 dana pembelian akan dikembalikan.
Jika Anda memilih Sebagian, masukkan jumlah pengembalian dana sebagian di kolom Jumlah. Anda dapat hanya mengembalikan dana hingga jumlah total pembelian. Jika Anda telah memposting sebagian Anda hanya dapat memasukkan jumlah maksimum hingga jumlah yang tersisa pada pembelian. Selain itu, jika transaksi pembelian awal memiliki harga kotor dan bersih, Anda juga harus menyatakan apakah sebagian jumlah yang ingin Anda kembalikan adalah kotor atau bersih.
- Klik Simpan untuk memproses pengembalian dana (atau Batal untuk membatalkan).
Pengembalian dana akan diposting ke bulan pembelian awal jika bulan penagihan masih terbuka, jika tidak, pengembalian dana akan diposting ke tanggal saat ini.
Untuk pengembalian dana sebagian, pengembalian dana tersebut akan diproses untuk jumlah sebagian dan pembagian keuntungan apa pun akan dipotong berdasarkan proporsi jumlah sebagian dengan jumlah penuh. Di kolom contoh pengembalian dana sebagian di atas, jumlah parsial adalah 0,50/1,12 = 45% dari harga kotor, jadi 45% dari pembagian keuntungan developer akan dikurangi.
Memeriksa UI apakah pengembalian dana telah diproses
Anda dapat mengetahui apakah pengembalian dana telah diproses atau belum dengan memilih bulan penagihan di bagian atas halaman Pengembalian dana. Ini adalah bulan pembelian jika bulan penagihan masih terbuka, atau bulan ini jika bulan penagihan ditutup. Bagian ini menampilkan daftar semua pengembalian dana yang telah yang diposting pada bulan tersebut.
Memposting pengembalian dana menggunakan API
Untuk memposting pengembalian dana, keluarkan permintaan POST ke
/organizations/{org_name}/monetization-packages/{package_id}/refund-transactions
,
dengan {package_id}
adalah identifikasi paket API tempat pengembalian dana
berlaku.
Saat mengajukan permintaan, Anda harus menentukannya sebagai parameter kueri:
- Identifikasi transaksi pembelian yang dananya dikembalikan.
- Jenis pendapatan (
GROSS
atauNET
) dari transaksi pembelian. - Jumlah pengembalian dana.
- Catatan yang menjelaskan alasan pengembalian dana.
Secara opsional, Anda dapat mengidentifikasi paket API sebagai parameter URL tempat pengembalian dana berlaku.
Lihat Setelan konfigurasi pengembalian dana untuk melihat daftar lengkap URL yang dapat Anda tentukan dalam permintaan pengembalian dana.
Misalnya, permintaan berikut memberikan pengembalian dana untuk transaksi pembelian. Pengembalian dana sebesar 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
Respons 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 tempat pengembalian dana 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 Jadwal lowongan monetisasi.