POST
/request.json۱. ایجاد درخواست پرداخت
ایجاد تراکنش پرداخت و دریافت paymentNumber
یک درخواست پرداخت جدید ثبت میکند و شناسه یکتای paymentNumber را بازمیگرداند. این شناسه برای هدایت پرداختکننده به درگاه و عملیات بعدی الزامی است.
پارامترهای ورودی
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
apiKey | string | required | کلید وبسرویس درگاه |
amount | integer | required | مبلغ به ریال. نباید کمتر از ۱۰۰۰۰۰ ریال باشد. |
callbackUrl | string | required | آدرس بازگشت پرداختکننده پس از اتمام عملیات بانکی |
invoiceNumber | string | required | شماره فاکتور پذیرنده |
callbackMethod | string | optional | روش بازگشت به callbackUrl: get یا post — پیشفرض: post |
payerName | string | optional | نام پرداختکننده |
payerMobile | string | optional | موبایل پرداختکننده — قالب 09xxxxxxxxx |
payerEmail | string | optional | ایمیل پرداختکننده |
description | string | optional | شرح تراکنش |
freezeCardNumber | string | optional | محدودسازی پرداخت به یک کارت ۱۶ رقمی |
freeze_card_number | string | optional | معادل freezeCardNumber — ارسال همزمان هر دو مجاز نیست |
freezeCardNumberList | string[] | optional | فهرست کارتهای ۱۶ رقمی مجاز |
affiliateCode | string | optional | کد معرف |
فیلدهای پاسخ
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
status | boolean | required | نتیجه عملیات |
message | string | optional | پیام خطا در صورت عدم موفقیت؛ در موفقیت معمولاً رشته خالی است |
paymentNumber | string | required | شناسه یکتای پرداخت |
خطاهای احتمالی
| کد | پیام | راهحل |
|---|---|---|
| 400 | invalid_gateway | اطلاعات درگاه معتبر نیست |
| 400 | inactive_user | حساب کاربری درگاه غیرفعال است |
| 400 | invalid_amount | مبلغ کمتر از حداقل مجاز یا بیش از سقف مجاز است |
| 400 | invalid_callback_url | آدرس بازگشت درگاه با آدرس ثبت شده در سیستم مطابقت ندارد |
| 400 | invalid_ip | مقدار ip معتبر نیست |
| 400 | no_terminal | ترمینال فعال برای این درگاه یافت نشد |
| 429 | rate_limit | سقف نرخ درخواست ایجاد پرداخت: ۳۰۰۰ در دقیقه |
صفحات مرتبط
آیا این صفحه مفید بود؟