درحال مشاهده اسناد 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 را به یکی از میاناهای برنامهسازی کاربردی زیر صادر کنید، که در آن {developer_id} نشانی ایمیل توسعهدهنده است:
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances: مانده حساب پیشپرداخت و اطلاعات تنظیمات تکرارشونده را برای توسعهدهنده برمیگرداند./mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: اطلاعات تراز حساب پیشپرداخت شامل تراز فعلی و کل، مصرف، افزایش موجودی، و مالیات مصرف را برمیگرداند.
میتوانید پارامترهای پُرسمان زیر را برای فیلتر کردن نتایج ارسال کنید:
| پارامتر پُرسمان | شرح |
|---|---|
all |
پرچمی که مشخص میکند آیا همه بستههای API برگردانده شود یا نه. اگر روی false تنظیم شود، تعداد بستههای میانای برنامهسازی کاربردی برگشتی در هر صفحه با پارامتر پُرسمان size تعریف میشود. پیشفرض نادرست است. |
size |
تعداد بستههای API برگرداندهشده در هر صفحه. پیشفرض ۲۰ است. اگر پارامتر پُرسمان all روی true تنظیم شده باشد، این پارامتر نادیده گرفته میشود. |
page |
شماره صفحهای که میخواهید به آن برگردید (اگر محتوا صفحهبندی شده باشد). اگر پارامتر پُرسمان all روی 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 تنظیم شود، تعداد بستههای میانای برنامهسازی کاربردی برگشتی در هر صفحه با پارامتر پُرسمان size تعریف میشود. پیشفرض نادرست است. |
size |
تعداد بستههای API برگرداندهشده در هر صفحه. پیشفرض ۲۰ است. اگر پارامتر پُرسمان all روی true تنظیم شده باشد، این پارامتر نادیده گرفته میشود. |
page |
شماره صفحهای که میخواهید به آن برگردید (اگر محتوا صفحهبندی شده باشد). اگر پارامتر پُرسمان all روی 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
پاسخ مشابه پاسخی است که در بالا هنگام مشاهده تراز حساب پیشپرداخت برای توسعهدهنده نشان داده شده است.
مدیریت تراز حساب پیشپرداخت بااستفاده از ارائهدهنده پرداخت
با راهاندازی حساب فروشنده با ارائهدهنده پرداخت طرف سوم، مثل Worldpay، تراز حساب پیشپرداخت را مدیریت کنید. شکل زیر نحوه مدیریت موجودی حساب پیشپرداخت را بااستفاده از ارائهدهنده پرداخت Worldpay نشان میدهد.

جدول زیر هر مرحله از جریان مدیریت تراز حساب پیشپرداخت را که در بالا نشان داده شده است شرح میدهد.
| مرحله | شرح |
|---|---|
| ۰ |
مراحل پیشنیاز بهعنوان ارائهدهنده API، برای راهاندازی ارائهدهنده پرداخت شخص ثالث، مثل Worldpay، باید: |
| ۱ |
برای راهاندازی جریان، مصرفکننده میانای برنامهسازی کاربردی یکی از کارهای زیر را در
درگاه توسعهدهنده انجام میدهد:
|
| ۲ | درگاه توسعهدهنده پرداخت را ازطریق Edge برای توسعهدهنده با شناسه ارائهدهنده، مبلغ مجدد، و ارز آغاز میکند. برای کسب اطلاعات درباره استفاده از API برای شروع پرداخت، شروع پرداخت به حساب پیشپرداخت بااستفاده از ارائهدهنده پرداخت را ببینید. |
| 3 | Edge ارائهدهنده را براساس شناسه پیدا میکند و تشخیص میدهد که حساب Worldpay است. |
| ۴ | Edge کد سفارشی تولید میکند. |
| ۵ | Edge سفارش پرداخت را در Worldpay ایجاد میکند. |
| ۶ | Worldpay شناسه مرجعی برای سفارش و نشانی وب با زمان محدود برای تکمیل آن برمیگرداند. |
| ۷ |
پاسخ Worldpay به پاسخ عمومی Edge /payment API تبدیل میشود، که
به درگاه توسعهدهندگان برگردانده میشود تا تماس آغازشده در مرحله ۲ تکمیل شود. برای مثال:
{
"isRecurring": "false",
"orderCode": "1234",
"referenceId": "3042815493",
"referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
"success": "true"
}
|
| ۸ | درگاه توسعهدهندگان نشانیهای وب برگشتی (برای موفقیت، شکست، و غیره) را بهعنوان پارامترهای پُرسمان به نشانی وب اضافه میکند. |
| ۹ | در مرحله ۱، درگاه توسعهدهنده با هدایت کردن مرورگر مصرفکننده API به نشانی وب اصلاحشده به درخواست پاسخ میدهد. |
| ۱۰ | مصرفکننده API فرم درخواست را تکمیل میکند و پردازش را با Worldpay آغاز میکند. |
| ۱۱ | Worldpay اطلاعات صورتحساب را دریافت میکند و پرداخت را پردازش میکند. درصورت موفقیت، Worldpay بااستفاده از «رمز MAC» پیکربندیشده در Worldpay و درگاه توسعهدهندگان، «کد اصالتسنجی پیام» (MAC) تولید میکند. |
| ۱۲ | Worldpay مرورگر مصرفکننده API را به نشانی وب تماس برگشتی موفق (از مرحله ۸) هدایت میکند و MAC را بهعنوان پارامتر پُرسمان و مقدار را پیوست میکند. |
| ۱۳ | مرورگر نشانی وب را در درگاه توسعهدهنده با مقدار و MAC درخواستی فرا میخواند. |
| ۱۴ | درگاه MAC را دربرابر رمز MAC درستیسنجی میکند. «کد اصالت پیام» از اینکه فردی بهطور خودسرانه ادعا کند پرداختهای موفقیتآمیز انجام شده است جلوگیری میکند. |
| 15 | درگاه توسعهدهنده درخواستی به Edge ارسال میکند تا تراز حساب پیشپرداخت را مجدد بار کند. برای اطلاعات درباره استفاده از API برای بار کردن مجدد تراز حساب، به بار کردن مجدد تراز حساب پیشپرداخت بااستفاده از API مراجعه کنید. |
بخشهای زیر مراحل لازم برای مدیریت ترازهای پیشپرداخت بااستفاده از ارائهدهنده پرداخت طرف سوم را توضیح میدهد:
- راهاندازی حساب فروشنده با ارائهدهنده پرداخت Worldpay
- پیکربندی ارائهدهنده پرداخت در Edge
- مشاهده ارائهدهندگان پرداخت پیکربندیشده برای سازمان شما
- فعال کردن و پیکربندی واحدهای لازم در درگاه توسعهدهنده
- شروع پرداخت به حساب پیشپرداخت بااستفاده از ارائهدهنده پرداخت
- افزایش موجودی حساب پیشپرداخت بااستفاده از API
- حذف کردن ارائهدهنده پرداخت طرف سوم
راهاندازی حساب فروشنده با ارائهدهنده پرداخت Worldpay
قبلاز شروع، باید با ارائهدهنده پرداخت طرف سوم (Worldpay) تماس بگیرید تا حساب(های) فروشندهتان را راهاندازی کنید. توصیه میشود دو حساب راهاندازی کنید، یکی برای آزمایش و دیگری برای تولید. برای اطلاعات بیشتر درباره حسابهای فروشنده Worldpay، به www.worldpay.com و wp-support.crm.worldpay.com (مرکز پشتیبانی Worldpay) مراجعه کنید.
پساز راهاندازی حساب فروشنده و دریافت اطلاعات اعتباری حساب، برای پیکربندی حساب فروشنده با Worldpay:
- به https://secure.worldpay.com/sso/public/auth/login.html پیمایش کنید.
- بااستفاده از اعتبارنامههایی که Worldpay دراختیارتان قرار داده است، به سیستم حساب Worldpay خود وارد شوید.
- گذرواژه XML و کلید محرمانه کد اصالتسنجی پیام (MAC) را تنظیم کنید:
- روی نمایه کلیک کنید.
- گذرواژه را برای استفاده هنگام پیکربندی ارائهدهنده پرداخت Worldpay در Edge در فیلد گذرواژه XML تنظیم کنید.
- کلید رمز MAC با ۲۰ تا ۳۰ نویسه را در فیلد کلید رمز MAC هدایت وارد کنید.
- روی ذخیره نمایه کلیک کنید
- افزودن سرور مدیریت Apigee Edge به فهرست پروتکلهای اینترنتی فروشنده (فهرست مجازها):
- روی نمایه > محیط فروشنده کلیک کنید.
- روی آدرس IP آزمایشی جدید کلیک کنید.
- پروتکل اینترنتی سرور مدیریت Apigee Edge را وارد کنید.
- روی ذخیره کلیک کنید.
- نشانی وب فروشنده را پیکربندی کنید تا پارامترهای Worldpay، ازجمله روش،
کد اصالتسنجی پیام (MAC) را اضافه کند:
- روی نصبها > صفحات پرداخت میزبانیشده > صفحه پرداخت طراح کلیک کنید.
- در بخش ویرایش صفحات پرداخت، شناسه نصب خود را از فهرست کرکرهای انتخاب کانال انتخاب کنید.
- در برگه «داراییها»، ویرایش پیکربندی فروشنده را انتخاب کنید.
- مقدار پارامترهای «ارسال نشانی وب» را روی درست تنظیم کنید.
- روی برگه انتشار کلیک کنید.
- تغییرات را بهصورت زیر ارتقا دهید:
- برای محیطهای آزمایشی، روی ارتقا در زیر طراحی کلیک کنید تا از «طراحی» به «جعبه شنی» ارتقا دهید.
- برای محیطهای تولید، روی ارتقا در جعبه شنی کلیک کنید تا از «جعبه شنی» به «تولید» ارتقا دهید.
پیکربندی ارائهدهنده پرداخت در Edge
مرحله بعدی پیکربندی ارائهدهنده پرداخت در Edge است.
میتوانید ارائهدهنده پرداختتان را برای سازمانی خاص بااستفاده از میانای برنامهسازی کاربردی زیر پیکربندی کنید:
/organizations/{org-name}/providersفقط مشتریان Apigee Edge Private Cloud با امتیازهای سرپرست سیستم میتوانند ارائهدهنده پرداخت جهانی را بااستفاده از API زیر بهصورت اختیاری پیکربندی کنند:
/config/providers
هنگام فراخواندن هر API، باید اطلاعات زیر را در بدنه درخواست مشخص کنید:
| پارامتر | شرح | الزامی |
authType |
شناسه نصب ارائهشده توسط ارائهدهنده پرداخت. | بله |
credential |
اعتبارنامههای کدبندیشده با Base64 (username:XMLpassword) برای حساب فروشنده Worldpay شما؛ username معادل کد فروشنده (با حروف بزرگ) است و XMLpassword گذرواژه XML را که در مرحله قبلی هنگام راهاندازی حساب فروشنده Worldpay تنظیم کردید مشخص میکند. |
بله |
description |
شرح ارائهدهنده پرداخت. | نه |
endpoint |
نقطه پایانی برای دسترسی به ارائهدهنده پرداخت
|
بله |
merchantCode |
کد فروشنده ارائهشده توسط ارائهدهنده پرداخت به مصرفکننده میانای برنامهسازی کاربردی | بله |
name |
نامی که برای ارائهدهنده استفاده میشود.
فقط مشتریان Apigee Edge Private Cloud: برای ارائهدهندگان پرداخت جهانی، مطمئن شوید که نام در همه سازمانهای Edge منحصربهفرد باشد. توصیه میشود که برای شناسایی آسان، WorldPay (حروفغیرحساس) را در نام ارائهدهنده اضافه کنید. برای مثال: |
بله |
برای مثال، دستور زیر حساب فروشندهای را با Worldpay با نام Worldpay-myorg راهاندازی میکند:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Worldpay-myorg",
"description": "Worldpay payment provider",
"endpoint": "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp",
"authType": "123456",
"credential": "dXNlcm5hbWU6cGFzc3dvcmQ=",
"merchantCode": "myMerchantCode"
}' \
"https://api.enterprise.apigee.com/v1/organizations/myOrg/providers" \
-u email:password
مشاهده ارائهدهندگان پرداخت طرف سوم
با صدور درخواست GET به منبع زیر، ارائهدهندگان پرداخت طرف سوم پیکربندیشده برای سازمان Edge خود را مشاهده و تأیید کنید:
/mint/organizations/{org-name}/providers
برای مثال، موارد زیر ارائهدهندگان پرداخت طرف ثالث را که درحالحاضر برای
myorg پیکربندی شدهاند نشان میدهد:
$ curl -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers" \ -u email:password
در زیر نمونهای از پاسخ نشان داده شده است که دو حساب فروشنده را نشان میدهد، یکی برای آزمایش و دیگری برای تولید.
{
"provider" : [ {
"authType" : "123456",
"credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=",
"description" : "Worldpay payment provider",
"endpoint" : "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp",
"id" : "worldpay-myorg",
"merchantCode" : "MERCH_CODE",
"name" : "Worldpay-myorg"
}, {
"authType" : "123456",
"credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=",
"description" : "Worldpay payment provider",
"endpoint" : "https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp",
"id" : "worldpay-test",
"merchantCode" : "MERCH_CODE_FROM_PROVIDER",
"name" : "Worldpay-test"
} ]
}
فعالسازی و پیکربندی واحدهای «درآمدزایی» و Worldpay در درگاه توسعهدهندگان
واحدهای موردنیاز «درآمدزایی» و Worldpay را در درگاه توسعهدهنده فعال کنید. برای جزئیات بیشتر، پیکربندی درآمدزایی در «پورتال توسعهدهندگان» را ببینید.
شروع پرداخت به حساب پیشپرداخت بااستفاده از ارائهدهنده پرداخت
همانطور که در مرحله ۲ از جریان مدیریت حساب پیشپرداخت نشان داده شده است، پرداخت به حساب پیشپرداخت بااستفاده از ارائهدهنده پرداخت زمانی ازسوی درگاه توسعهدهندگان آغاز میشود که مصرفکنندگان میانای برنامهسازی کاربردی:
- طرح تعرفه را بپذیرد، اما موجودی کافی در حساب پیشپرداخت خود نداشته باشد
- درخواست کنید به حساب پیشپرداخت او پول اضافه شود.
برای شروع پرداخت از ارائهدهنده پرداخت طرف سوم بااستفاده از API، درخواست POST به منبع زیر صادر کنید، که در آن {developer_id} نشانی ایمیل توسعهدهنده است.
/mint/organizations/{org_name}/developers/{developer_id}/payment?amount={amount}&provider={providerId}&supportedCurrencyId={currency}
وقتی درخواست را صادر میکنید، باید مقادیر زیر را بهعنوان پارامترهای پُرسمان مشخص کنید:
- مبلغی که باید به تراز حساب پیشپرداختشده اضافه شود (
amount={amount}) - شناسه ارائهدهنده پرداخت (
provider={providerId}) - واحد پول پشتیبانیشده (
supportedCurrencyId={currency})
علاوهبراین، باید جزئیات حساب پایه، مثل نشانی صورتحساب شرکت، را ارائه دهید.
برای مثال، دستور زیر موجودی حساب پیشپرداخت را بااستفاده از ارائهدهنده پرداخت Worldpay مجدد بار میکند. انتقال اولیه به حساب پیشپرداخت شما ۱۰ دلار امریکا خواهد بود (پارامتر پُرسمان amount روی 10 تنظیم شده است).
$ curl -H "Content-Type:application/xml" -X POST -d \
'{
"address1": "5115 Hopyard Ave.",
"city": "Pleasanton",
"country": "US",
"state": "CA",
"zip": "58158"
}'
' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/payment?amount=10&provider=worldpay-myorg&supportedCurrencyId=usd" \
-u email:password
در زیر نمونهای از پاسخ ارائه شده است:
{
"isRecurring": "false",
"orderCode": "1234",
"referenceId": "3042815493",
"referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
"success": "true"
}
نشانی وب صفحه «پرداخت امن Worldpay» در referenceUrl با کلید سفارش یکتای شما که بهعنوان پارامتر پُرسمان پیوست شده است برگردانده میشود.
بار کردن مجدد تراز حساب پیشپرداخت بااستفاده از API
همانطور که در مرحله ۱۵ از جریان مدیریت حساب پیشپرداخت نشان داده شده است، پساز درستیسنجی پردازش موفق توسط ارائهدهنده پرداخت، درگاه توسعهدهنده درخواستی برای بار کردن مجدد حساب پیشپرداخت به Edge ارسال میکند.
میتوانید موجودی حساب پیشپرداخت را بااستفاده از API برای توسعهدهنده یا شرکت، همانطور که در بخشهای زیر توضیح داده شده است، مجدد بار کنید.
افزودن موجودی حساب پیشپرداخت برای توسعهدهنده
برای بار کردن مجدد تراز حساب پیشپرداخت توسعهدهنده بااستفاده از API، درخواست POST به
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances صادر کنید، که در آن
{developer_id} نشانی ایمیل توسعهدهنده است. وقتی درخواست را صادر میکنید، باید در متن درخواست مقدار موردنظر برای افزودن به تراز و واحد پول استفادهشده را مشخص کنید.
برای مثال، درخواست زیر ۱۰۰۰ دلار به تراز حساب پیشپرداخت توسعهدهنده اضافه میکند:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"amount": 1000,
"supportedCurrency": {
"id": "usd"
}
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password
برای شرح ویژگیهای درخواست، خلاصه ویژگیهای درخواست برای بار کردن مجدد حساب پیشپرداخت را ببینید.
بار کردن مجدد موجودی حساب پیشپرداختشده برای شرکت
برای بار کردن مجدد تراز حساب پیشپرداختشده برای شرکتی که از API استفاده میکند، درخواست POST به
/mint/organizations/{org_name}/companies/{company_id}/developer-balances صادر کنید، که در آن
{company_id} شناسه شرکت است. وقتی درخواست را صادر میکنید، باید در متن درخواست مقدار موردنظر برای افزودن به تراز و واحد پول استفادهشده را مشخص کنید.
برای مثال، درخواست زیر ۱۰۰۰ دلار به تراز حساب پیشپرداخت شرکت اضافه میکند:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"amount": 1000,
"supportedCurrency": {
"id": "usd"
}
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password
برای شرح ویژگیهای درخواست، خلاصه ویژگیهای درخواست برای بار کردن مجدد حساب پیشپرداخت را ببینید.
خلاصه ویژگیهای درخواست برای بار کردن مجدد حساب پیشپرداخت
هنگام مجدد بار کردن تراز حساب پیشپرداخت بااستفاده از میانای برنامهسازی کاربردی، باید مشخصههای زیر را مشخص کنید:
| نام | شرح | پیشفرض | الزامی است؟ |
|---|---|---|---|
amount |
مبلغ اعمالشده بر موجودی پیشپرداخت (به ارز مربوطه). |
موجود نیست | بله |
supportedCurrency |
ارز استفادهشده برای تراز پیشپرداختشده. این ارز برای طرح در بسته میانای برنامهسازی کاربردی که توسعهدهنده خریداری کرده است تنظیم شده است. |
موجود نیست | بله |
حذف ارائهدهندگان پرداخت طرف سوم
با صدور درخواست DELETE به منبع زیر، میتوانید ارائهدهنده پرداخت طرف سوم پیکربندیشده برای سازمان Edge خود را حذف کنید:
برای حذف ارائهدهنده پرداخت برای سازمانی خاص، از API زیر استفاده کنید:
/mint/organizations/{org-name}/providers/idفقط مشتریان Apigee Edge Private Cloud با امتیازهای سرپرست سیستم میتوانند بهصورت اختیاری ارائهدهنده پرداخت جهانی را بااستفاده از میانای برنامهسازی کاربردی زیر حذف کنند:
/config/providers/id
برای مثال، دستور زیر ارائهدهندگان پرداخت طرف سوم را که درحالحاضر برای myorg پیکربندی شدهاند حذف میکند:
$ curl -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers/worldpay-myorg" \ -u email:password
مدیریت دستی تراز حساب پیشپرداخت
یا میتوانید با پیگیری دستی پرداختها یا ازطریق سیستم صورتحساب یکپارچه، بار کردن مجدد ترازهای پیشپرداخت را مدیریت کنید و سپس با فراخوانی API درآمدزایی، حساب را مجدداً بار کنید، همانطور که در بار کردن مجدد تراز حساب پیشپرداخت بااستفاده از API توضیح داده شده است.
راهاندازی بار کردن مجدد خودکار موجودی حساب پیشپرداخت بااستفاده از میانای برنامهسازی کاربردی
بخشهای زیر نحوه تنظیم کردن بارگیری مجدد خودکار موجودی حساب پیشپرداخت را برای توسعهدهنده یا شرکتی که از ارائهدهنده پرداخت طرف سوم استفاده میکند شرح میدهد. این گزینه برای مدیریت پرداختهای تکرارشونده برای طرحهای نرخ مفید است.
راهاندازی بار کردن مجدد خودکار موجودی حساب پیشپرداخت برای توسعهدهنده
برای راهاندازی مجدد بار کردن خودکار موجودی حساب پیشپرداخت برای توسعهدهنده زمانی که موجودی به زیر آستانه معینی میرسد،
درخواست POST به
/mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup صادر کنید،
که در آن {developer_id} نشانی ایمیل توسعهدهنده است.
هنگام صدور درخواست، باید موارد زیر را مشخص کنید:
- شناسه ارائهدهنده پرداخت برای استفاده در بار کردن مجدد حساب (
providerID) - پرچمی که بار کردن مجدد خودکار را فعال میکند (
isRecurring) - آستانهای که موجودی حساب پیشپرداخت باید به زیر آن برسد تا
مجدد بار کردن خودکار را راهاندازی کند (
replenishAmount) - مبلغی که بهطور خودکار به حساب اضافه میشود (
recurringAmount) - پارامتر پُرسمان
supportedCurrencyIDبرای مشخص کردن واحد پول.
در مثال زیر، وقتی تراز حساب پیشپرداخت توسعهدهنده به کمتر از ۵ دلار امریکا برسد، ۱۰ دلار امریکا دیگر بهطور خودکار به حساب اضافه خواهد شد.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"providerId": "worldpay-myorg",
"isRecurring" : true,
"replenishAmount" : 5,
"recurringAmount" : 10
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \
-u email:password
برای شرح ویژگیهای درخواست، به خلاصه ویژگیهای درخواست برای راهاندازی بار کردن مجدد خودکار حسابهای پیشپرداخت مراجعه کنید.
راهاندازی بار کردن مجدد خودکار موجودی حساب پیشپرداخت برای شرکت
برای تنظیم مجدد بار کردن خودکار موجودی حساب پیشپرداخت برای شرکت وقتی موجودی به زیر مقدار معینی میرسد،
درخواست POST به
/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup صادر کنید،
که در آن {company_id} شناسه
شرکت است.
هنگام صدور درخواست، باید موارد زیر را مشخص کنید:
- شناسه ارائهدهنده پرداخت برای استفاده در بار کردن مجدد حساب (
providerID) - پرچمی که بار کردن مجدد خودکار را فعال میکند (
isRecurring) - آستانهای که موجودی حساب پیشپرداخت باید به زیر آن برسد تا
مجدد بار کردن خودکار را راهاندازی کند (
replenishAmount) - مبلغی که بهطور خودکار به حساب اضافه میشود (
recurringAmount) - پارامتر پُرسمان
supportedCurrencyIDبرای مشخص کردن واحد پول.
در مثال زیر، وقتی تراز حساب پیشپرداخت شرکت به کمتر از ۵ دلار امریکا برسد، ۱۰ دلار امریکا دیگر بهطور خودکار به حساب اضافه خواهد شد.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"providerId": "worldpay-myorg",
"isRecurring" : true,
"replenishAmount" : 5,
"recurringAmount" : 10
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \
-u email:password
برای شرح ویژگیهای درخواست، به خلاصه ویژگیهای درخواست برای راهاندازی بار کردن مجدد خودکار حسابهای پیشپرداخت مراجعه کنید.
خلاصه ویژگیهای درخواست برای راهاندازی بار کردن مجدد خودکار حسابهای پیشپرداخت
هنگام مجدد بار کردن خودکار موجودی حساب پیشپرداخت بااستفاده از API، میتوانید مشخصههای زیر را تعیین کنید.
| نام | شرح | پیشفرض | الزامی است؟ |
|---|---|---|---|
providerId |
شناسه ارائهدهنده پرداخت. |
موجود نیست | بله |
chargePerUsage |
نادرست | نه | |
isRecurring |
پرچمی که مشخص میکند آیا بار کردن مجدد خودکار فعال است ( |
موجود نیست | بله |
replenishAmount |
آستانهای که موجودی حساب پیشپرداخت باید به زیر آن برسد تا مجدد بار کردن خودکار فعال شود. |
موجود نیست | بله |
recurringAmount |
مبلغی که هنگام فعال شدن بار کردن مجدد خودکار به موجودی حساب پیشپرداخت اضافه میشود. |
موجود نیست | بله |
انتقال به «صفحههای پرداخت میزبانیشده» WorldPay
WorldPay جریان پردازش پرداخت امن خود را بهروز کرده است تا از مجموعه جدیدی از صفحات استفاده کند که به آنها «صفحات پرداخت میزبانیشده» گفته میشود.
اگر ارائهدهنده(های) پرداخت WorldPay خود را بااستفاده از جریان پردازش پرداخت امن منسوخشده (قبلاز اوت ۲۰۱۷) پیکربندی کردهاید، باید قبلاز ژانویه ۲۰۱۸ به «صفحههای پرداخت میزبانیشده» جدید WorldPay انتقال دهید.
برای انتقال به «صفحات پرداخت میزبانیشده» WorldPay:
- با WorldPay تماس بگیرید تا حساب فعلیتان را به استفاده از «صفحههای پرداخت میزبانیشده» جدید انتقال دهید و شناسه نصب جدیدی برای حسابتان دریافت کنید.
- ارائهدهندگان پرداخت WorldPay جدید را همانطور که در پیکربندی ارائهدهنده پرداخت در Edge توضیح داده شده است پیکربندی کنید و شناسه نصب را در
فیلد
authTypeبگذرانید. - ارائهدهنده(های) پرداخت جدید را در درگاه توسعهدهندگان خود پیکربندی کنید، همانطور که در پیکربندی درآمدزایی در درگاه توسعهدهندگان توضیح داده شده است.
- اگر بار کردن مجدد خودکار حساب پیشپرداخت را بااستفاده از ارائهدهنده پرداخت راهاندازی کردهاید، باید بار کردن مجدد خودکار را بااستفاده از شناسه ارائهدهنده جدید، همانطور که در راهاندازی بار کردن مجدد خودکار تراز حساب پیشپرداخت بااستفاده از میانای برنامه کاربردی توضیح داده شده است، دوباره پیکربندی کنید.
مراحل بعدی
میتوانید برای هر توسعهدهنده پسپرداخت حد اعتبار تعیین کنید. در مدیریت ترازهای پسپرداخت با نحوه انجام این کار آشنا شوید.