ارسال درخواست پرداخت و دریافت توکن
- درخواست تراکنش و اخذ توکن
در این مرحله تمامی اطلاعات مربوط به تراکنش به تیپول ارسال میشود و تیپول پس از بررسی موارد درخواستی و در صورت موفق بودن درخواست، یک توکن (jwt) و یک کد پیگیری به همراه کد رهگیری تراکنش تولید خواهد کرد.
نحوه ارسال درخواست :
Request URL: https://Api.tipoul.com/pay/v1/gettoken
Type: post / json
:Body
| اهمیت | توضیحات | نوع فیلد | نام فیلد |
| اجباری | کد توکن درگاه (قابل کپی از پنل کابری) | String | GateToken |
| اجباری | مبلغ تراکنش (حداقل ۱۰۰۰۰ و حداکثر ۴۹۹۵۰۰۰۰ ریال) | Number | Amount |
| اجباری | آدرس برگشت سایت پذیرنده | String | CallBackUrl |
| اختیاری | نام کاربری مشتری پذیرنده | String | PayerUserId |
| اختیاری | نام مشتری پذیرنده | String | PayerName |
| اختیاری | شماره موبایل مشتری پذیرنده | String | PayerMobile |
| اختیاری | ایمیل مشتری پذیرنده | String | PayerMail |
| اختیاری | شماره فاکتور پرداخت | String | FactorNumber |
| اختیاری | شماره کارت های مجاز جهت انجام تراکنش | <List<string | ValidCardNum |
| اختیاری | فیلد گزارشی برای مشتری پذیرنده | String | BlankForPayer |
| اختیاری | فیلد گزارشی برای تراکنش | String | BlankForTransaction |
| اختیاری | توضیحات تراکنش | String | Description |
| اختیاری | شرکت ارائه دهنده خدمات پرداخت | string | IPG |
قالب پاسخ دریافتی :
| نام فیلد | نوع فیلد | توضیحات |
| Code | Int | – |
| Success | Bool | موفق یا ناموفق |
| Result | ||
| AccessToken | Strin | توکن مورد استفاده در مرحله بعد جهت هدایت پرداخت کننده به درگاه |
| TipoulTraceNumber | Number | کد پیگیری تراکنش تیپول |
| TipoulTrackNumber | Number | کد رهگیری درخواست |
توجه:
- ادرس برگشت از سایت پذیرنده باید تحت دامنه ای باشد که به هنگام ایجاد درگاه ثبت شده است.
- ارسال درخواست به وب سرویس های تیپول تنها از آدرس آی پی مربوط به دامنه ثبت شده امکان پذیر خواهد بود.
- در صورت تغییر آدرس آی پی و یا سرور مورد استفاده، لازم است آی پی جدید به پشتیبانی تیپول از طریق تیکت ارسال شود.
- تغییر دامنه ثبت شده برای درگاه امکان پذیر نخواهد بود.
نکات مهم :
- فیلد های اختیاری به جهت گزارش گیری کامل، دقیق و بهتر در نظر گرفته شده اند و ارسال هرچه کامل تر و دقیق تر فیلد ها به پذیرندگان در گزارش گیری و آمار گیری تراکنش ها و مشتریان خود بسیار مفید خواهد بود.
- شناسایی یکتایی هر پرداخت کننده و یا مشتری توسط سیستم تیپول، با بررسی فیلد های ( نام، نام کاربری، شماره موبایل و ایمیل مشتری پذیرنده) انجام میشود لذا توصیه میشود برای گزارش گیری دقیق تر و بررسی کامل تر و پیگیری بهتر تراکنش ها و مشتریان خود، حداقل یکی از فیلد های مذکور مربوط به هر پرداخت کننده یا مشتری ارسال شود.
- جهت استفاده از درگاه موبایلی، فیلد شماره موبایل مشتری پذیرنده ارسال شود.
در صورتی که شماره موبایل پرداخت کننده ارسال شود، در صفحه پرداخت شماره کارت های مربوط به پرداخت کننده نمایش داده خواهد شد و دیگر نیازی به وارد کردن شماره کارت نخواهد بود. با این روش میتوانید برای مشتری خود تجربه بهتری از پرداخت مهیا کنید.
- تراکنش های خود را بر اساس اطلاعات اختیاری ارسالی در این مرحله از پنل تیپول میتوانید رهگیری و تحلیل کرده و گزارشات خود را بر اساس این فیلد ها نیز فیلتر یا بررسی کنید.
- در صورتی که میخواهید کاربری را اجبار به پرداخت از یک کارت بانکی خاصی که به شما معرفی کرده نمایید، شماره کارت یا کارت های مذکور را به صورت لیست در فیلد validcardnum ارسال فرمایید.
- فیلد های blank به جهت استفاده در فرایند گزارش گیری و تحلیل در پنل تیپول برای استفاده شما در نظر گرفته شده است که هر معیار دیگری اگر برای دسته بندی، ایجاد تمایز، بررسی و یا تشخیص تراکنش ها و یا مشتریان خود دارید را در این دو فیلد ارسال نمایید. سپس در پنل هوشمند گزارش گیری تیپول، میتوانید بر اساس فیلد های مذکور نیز گزارشات و تحلیل های خود را شخصی نمایید.
- فیلد توضیحات تراکنش به شما میتواند در جست و جوی تراکنش های خود کمک کننده باشد چرا که بر اساس محتوای این فیلد نیز میتوانید تراکنش های خود را جست و جو کرده و بررسی کنید.
- تیپول به صورت پیشفرض تراکنش های درخواستی را با استفاده از سیستم سویچینگ و هدایت هوشمند تراکنش های خود به بهترین، مناسب ترین و در دسترس ترین درگاه شاپرک یا PSP ارسال میکند، لیکن چنانچه در نظر دارید تراکنش های شما از PSP مشخص یا خاصی انجام شود، این فیلد را با کلید مربوط به PSP به صورت زیر ارسال نمایید :
| نام ارائه دهنده خدمات پرداخت یا PSP | کلید مربوطه |
| ایران کیش | IRK |
| سپهر | Sepehr |
توجه : PSP های بیشتر به زودی به لیست فوق اضافه و به اطلاع عموم خواهد رسید.
جهت مطالعه ادامه مستند بر روی دکمه ادامه کلیک نمایید