شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
برای مدیریت موجودی حساب پیش پرداخت، می توانید:
- موجودی حساب پیش پرداخت فعلی را مشاهده کنید. مشاهده موجودی حساب های پیش پرداخت با استفاده از API را ببینید.
- با استفاده از یک ارائه دهنده پرداخت شخص ثالث، مانند Worldpay، موجودی حساب را دوباره بارگیری کنید (به آن پول اضافه کنید). به مدیریت موجودی های پیش پرداخت با استفاده از ارائه دهنده پرداخت شخص ثالث مراجعه کنید.
همچنین، میتوانید با ردیابی پرداختها به صورت دستی یا از طریق یک سیستم صورتحساب یکپارچه و سپس تماس با API کسب درآمد برای بارگیری مجدد حساب، بارگذاری مجدد را مدیریت کنید، همانطور که در مدیریت موجودیهای پیشپرداخت دستی توضیح داده شده است.
- با استفاده از API کسب درآمد و ارائهدهنده پرداخت شخص ثالث، مانند Worldpay، زمانی که موجودی حساب پیشپرداخت شده به زیر آستانه معینی میرسد، بارگذاری مجدد خودکار را تنظیم کنید. این گزینه برای مدیریت پرداخت های مکرر برای طرح های نرخ مفید است. برای اطلاعات، به تنظیم بارگیری مجدد خودکار موجودی حساب های پیش پرداخت با استفاده از API مراجعه کنید.
چگونه می توانم مانده حساب پیش پرداخت را محاسبه کنم؟
هنگام مشاهده موجودی حساب پیش پرداخت برای یک توسعه دهنده یا شرکت، همانطور که در بخش های زیر توضیح داده شده است، باید مقادیر زیر را از پاسخ به دست آورید:
-
amount
: کل مقدار پول موجود برای دوره صورتحساب فعلی. زمانی که حساب پیش پرداخت را با استفاده از روش های توضیح داده شده در این بخش مجدداً بارگیری می کنید، این مقدار به روز می شود. -
usage
: کل مبلغ استفاده شده در طول دوره صورتحساب فعلی. این مقدار با هر تراکنش پولی واجد شرایط یا با صدور اعتبار (مثبت یا منفی) به روز می شود.
میتوانید مانده حساب پیشپرداخت شده برای دوره صورتحساب جاری را با کم کردن ارزش usage
از amount
محاسبه کنید. به عنوان مثال، اگر مقدار amount
335.50 و مقدار usage
34 باشد، باقیمانده به صورت زیر محاسبه می شود:
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 پرس و جو تعریف میشود. پیش فرض ها به false . |
size | تعداد بسته های API برگردانده شده در هر صفحه. پیشفرض 20 است. اگر پارامتر 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 پرس و جو تعریف میشود. پیش فرض ها به false . |
size | تعداد بسته های API برگردانده شده در هر صفحه. پیشفرض 20 است. اگر پارامتر 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
پاسخ مشابه پاسخی است که در بالا نشان داده شده است، هنگام مشاهده موجودی حساب های پیش پرداخت برای یک توسعه دهنده.