محاسبه کارمزد تراکنش (FeeCalculation)
متد feeCalculation به شما امکان میدهد تا قبل از ایجاد درخواست پرداخت، میزان کارمزد یک تراکنش را محاسبه و دریافت کنید.
این متد زمانی مفید است که بخواهید کارمزد تراکنش را پیش از شروع فرآیند پرداخت به کاربر نمایش دهید یا در محاسبات خود لحاظ کنید.
آدرس وبسرویس
POST
https://payment.finopal.ir/api/v1/payment/feeCalculationپارامترهای ارسالی
| نام | نوع | الزام | توضیحات |
|---|---|---|---|
| merchant_id | String | بله | کد اختصاصی پذیرنده (درگاه) |
| amount | Integer | بله | مبلغ تراکنش به ریال (حداقل ۱۰۰۰) |
نمونه درخواست (curl)
Bash
curl -X POST \
https://payment.finopal.ir/api/v1/payment/feeCalculation \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"merchant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"amount": 1000000
}'مقادیر بازگشتی
| نام | نوع | توضیحات |
|---|---|---|
| code | Number | کد وضعیت درخواست؛ کد 100 یعنی موفق |
| message | String | پیام وضعیت درخواست |
| amount | Integer | مبلغ اصلی به ریال |
| fee | Integer | کارمزد به ریال |
| fee_type | String |
نوع پرداختکننده کارمزد:
Merchant (پذیرنده) یا
Payer (پرداختکننده)
|
نمونه پاسخ موفق
JSON
{
"success": true,
"code": 100,
"message": "محاسبه کارمزد با موفقیت انجام شد",
"amount": 1000000,
"fee": 20000,
"fee_type": "Merchant"
}نکات
- کارمزد بر اساس درصد کارمزد درگاه و سقف کارمزد (
settlement_max) محاسبه میشود. - اگر
customer_feeروی درگاه فعال باشد،fee_typeبرابرPayerاست؛ در غیر این صورتMerchant. - این متد پرداخت ایجاد نمیکند و فقط برای پیشنمایش/محاسبه است.