شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
برای مدیریت موجودی در یک حساب پیشپرداخت، میتوانید:
- موجودی فعلی حساب پیشپرداخت را مشاهده کنید. به مشاهده موجودی حسابهای پیشپرداخت با استفاده از API مراجعه کنید.
- در صورت نیاز، موجودی حساب را با استفاده از یک ارائهدهنده پرداخت شخص ثالث، مانند Worldpay، مجدداً شارژ کنید (به آن پول اضافه کنید). به بخش مدیریت موجودیهای پیشپرداخت با استفاده از یک ارائهدهنده پرداخت شخص ثالث مراجعه کنید.
از طرف دیگر، میتوانید با پیگیری دستی پرداختها یا از طریق یک سیستم صورتحساب یکپارچه و سپس فراخوانی API کسب درآمد برای شارژ مجدد حساب، همانطور که در مدیریت دستی ماندههای پیشپرداخت توضیح داده شده است، شارژ مجدد را مدیریت کنید.
- با استفاده از API کسب درآمد و یک ارائه دهنده پرداخت شخص ثالث، مانند Worldpay، شارژ مجدد خودکار را هنگامی که موجودی حساب پیشپرداخت از آستانه خاصی پایینتر میآید، تنظیم کنید. این گزینه برای مدیریت پرداختهای مکرر برای طرحهای نرخی مفید است. برای اطلاعات بیشتر، به تنظیم شارژ مجدد خودکار موجودی حسابهای پیشپرداخت با استفاده از API مراجعه کنید.
چگونه میتوانم مانده حساب پیشپرداخت را محاسبه کنم؟
هنگام مشاهده موجودی حساب پیشپرداخت یک توسعهدهنده یا شرکت، همانطور که در بخشهای بعدی توضیح داده شده است، باید مقادیر زیر را از پاسخ دریافت کنید:
-
amount: کل مبلغ موجود برای دوره صورتحساب فعلی. این مقدار هنگام شارژ مجدد حساب پیشپرداخت با استفاده از روشهای شرح داده شده در این بخش، بهروزرسانی میشود. -
usage: کل مبلغ پول استفاده شده در طول دوره صورتحساب فعلی. این مقدار با هر تراکنش پولی واجد شرایط یا با صدور اعتبار (مثبت یا منفی) بهروزرسانی میشود.
شما میتوانید مانده حساب پیشپرداخت را برای دوره صورتحساب فعلی با کم کردن مقدار usage از مقدار amount محاسبه کنید. برای مثال، اگر مقدار amount ۳۳۵.۵۰ و مقدار usage ۳۴ باشد، مانده حساب به صورت زیر محاسبه میشود:
amount(335.50) - usage(34) = 229.50مشاهده مانده حسابهای پیشپرداخت با استفاده از API
بخشهای زیر نحوه مشاهده موجودی حسابهای پیشپرداخت برای یک توسعهدهنده یا شرکت با استفاده از API را شرح میدهند.
مشاهده مانده حسابهای پیشپرداخت برای یک توسعهدهنده
برای مشاهده موجودی حسابهای پیشپرداخت یک توسعهدهنده، یک درخواست GET به یکی از APIهای زیر ارسال کنید، که در آن {developer_id} آدرس ایمیل توسعهدهنده است:
-
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances: موجودی حساب پیشپرداخت و اطلاعات تنظیمات دورهای برای یک توسعهدهنده را برمیگرداند. -
/mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: اطلاعات موجودی حساب پیشپرداخت شامل موجودی فعلی و کل، میزان استفاده، افزایش اعتبار و مالیات استفاده را برمیگرداند.
شما میتوانید پارامترهای پرسوجوی زیر را برای فیلتر کردن نتایج ارسال کنید:
| پارامتر پرس و جو | توضیحات |
|---|---|
all | پرچمی که مشخص میکند آیا همه بستههای API برگردانده شوند یا خیر. اگر روی false تنظیم شود، تعداد بستههای API برگردانده شده در هر صفحه توسط پارامتر size query تعریف میشود. مقدار پیشفرض false است. |
size | تعداد بستههای API برگردانده شده در هر صفحه. مقدار پیشفرض ۲۰ است. اگر پارامتر all query روی true تنظیم شده باشد، این پارامتر نادیده گرفته میشود. |
page | شماره صفحهای که میخواهید برگردانید (اگر محتوا صفحهبندی شده باشد). اگر پارامتر all query روی true تنظیم شده باشد، این پارامتر نادیده گرفته میشود. |
currencyId | شناسه ارزی که میخواهید مانده حساب پیشپرداخت آن را مشاهده کنید. |
برای مثال:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password
در ادامه نمونهای از پاسخ ارائه شده است:
{ "developerBalance": [ { "amount": 2005, "chargePerUsage": false, "id": "your-provider-id", "isRecurring": false, "supportedCurrency": { "description": "United States Dollars", "displayName": "United States Dollars", "id": "usd", "name": "USD", "organization": { "address": [ { "address1": "10 Almaden Blvd.", "city": "San Jose", "country": "US", "id": "32e808d8-3a3c-4d76-a0ae-17d70a982c61", "isPrimary": true, "state": "CA", "zip": "95113" } ], "approveTrusted": false, "approveUntrusted": false, "billingCycle": "CALENDAR_MONTH", "country": "US", "currency": "USD", "description": "my-org", "groupOrganization": false, "hasBillingAdjustment": false, "hasBroker": false, "hasSelfBilling": false, "hasSeparateInvoiceForProduct": false, "id": "my-org", "issueNettingStmt": false, "name": "my-org", "nettingStmtPerCurrency": false, "selfBillingAsExchOrg": false, "selfBillingForAllDev": false, "separateInvoiceForFees": false, "status": "ACTIVE", "supportedBillingType": "BOTH", "taxModel": "HYBRID", "timezone": "UTC" }, "status": "ACTIVE", "virtualCurrency": false }, "usage": 2.1572 } ], "totalRecords": 1 }
مشاهده مانده حسابهای پیشپرداخت یک شرکت
برای مشاهده موجودی حسابهای پیشپرداخت یک شرکت، یک درخواست GET به /mint/organizations/{org_name}/companies/{company_id}/developer-balances ارسال کنید، که در آن {company_id} شناسه شرکت است. اگر شرکت پیشپرداخت شده باشد، درخواست، موجودی فعلی حساب پیشپرداخت شده را بازیابی میکند. اگر شرکت پسپرداخت شده باشد، درخواست، سقف اعتبار فعلی را بازیابی میکند.
شما میتوانید پارامترهای پرسوجوی زیر را برای فیلتر کردن نتایج ارسال کنید:
| پارامتر پرس و جو | توضیحات |
|---|---|
all | پرچمی که مشخص میکند آیا همه بستههای API برگردانده شوند یا خیر. اگر روی false تنظیم شود، تعداد بستههای API برگردانده شده در هر صفحه توسط پارامتر size query تعریف میشود. مقدار پیشفرض false است. |
size | تعداد بستههای API برگردانده شده در هر صفحه. مقدار پیشفرض ۲۰ است. اگر پارامتر all query روی true تنظیم شده باشد، این پارامتر نادیده گرفته میشود. |
page | شماره صفحهای که میخواهید برگردانید (اگر محتوا صفحهبندی شده باشد). اگر پارامتر all query روی true تنظیم شده باشد، این پارامتر نادیده گرفته میشود. |
currencyId | شناسه ارزی که میخواهید مانده حساب پیشپرداخت آن را مشاهده کنید. |
برای مثال:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password
پاسخ مشابه پاسخی است که در بالا هنگام مشاهده مانده حسابهای پیشپرداخت یک توسعهدهنده نشان داده شده است.