هر ترمینال دارای یک api_key اختصاصی می‌باشد که برای برقراری ارتباط با درگاه استفاده خواهد شد. مقدار api_key در زمان دریافت ترمینال به شما اختصاص داده می‌شود. ارتباط با اسکریپت درگاه پرداخت باید از طریق متد POST انجام شود.
پروسه پرداخت:
- جهت انجام پرداخت آنلاین ابتدا باید یک شناسه پرداخت دریافت کنید، سپس کاربر را به آدرسی که شناسه پرداخت در انتهای آن قرار دارد منتقل کنید تا مراحل پرداخت در شبکه شتاب انجام شود، پس از آن کاربر به سایت شما برگردانده می‌شود و می‌توانید صحت پرداخت را بررسی کنید.
دریافت شناسه پرداخت:
- برای این منظور باید یک درخواست به صورت JSON یا FORM_DATA به آدرس زیر ارسال کنید. مقادیری که باید ارسال شوند به شرح زیر می‌باشد:
https://polam.io/invoice/request
{
“api_key”:”api_key”,
“amount”:amount,
“return_url”:”return_url”
}
| شناسه ترمینال | api_key |
| مبلغ (به ریال) | amount |
| آدرس بازگشت (به صورت urlencode ارسال شود) | return_url |
- بعد از ارسال این درخواست یک آرایه با فرمت JSON در جواب شما ارسال می‌شود. اگر ورودی‌ها صحیح باشند و خطایی رخ ندهد خروجی به صورت زیر خواهد بود:
| وضعیت (عدد 1) | status |
| شناسه پرداخت | invoice_key |
بعد از دریافت شناسه پرداخت آن را در دیتابیس ذخیره کنید، چون در مراحل بعدی برای بررسی صحت پرداخت به آن نیاز خواهید داشت. سپس می‌توانید شناسه پرداخت را در انتهای آدرس زیر قرار دهید و کاربر را به این آدرس منتقل کنید. ولی اگر خطایی رخ دهد خروجی به صورت زیر خواهد بود:
https://polam.io/invoice/pay/{invoice_key}
| وضعیت (عدد ۰) | status |
| کد خطا | errorCode |
| توضیحات خطا | errorDescription |
بررسی صحت پرداخت:
پس از اینکه کاربر به سایت شما برگشت داده شد، می‌توانید صحت پرداخت را چک کنید، برای این منظور کافیست یک درخواست به آدرس زیر ارسال کنید.مقدار invoice_key را باید در انتهای ادرس قرار دهید و api_key را به صورت JSON یا FORM_DATA ارسال کنید:
https://polam.io/invoice/check/{invoice_key}
{
“api_key”:”5a783ac9397d46c195871eb72349ec23″
}
| شناسه ترمینال | statusapi_key |
اگر ورودی‌ها صحیح باشند و خطایی رخ ندهد خروجی به صورت زیر خواهد بود:
| وضعیت (عدد 0) | status |
| کد خطا | errorCode |
| توضیحات خطا | errorDescription |
جدول خطاها:
| توضیحات | کد خطا |
|---|---|
| نوع درخواست باید POST باشد. | 100 |
| api_key ارسال نشده است یا صحیح نیست. | 101 |
| مبلغ ارسال نشده است یا کمتر از ۱۰۰۰ ریال است. | 102 |
| آدرس بازگشت ارسال نشده است. | 103 |
| ترمینال در پروسه تائید است. | 104 |
| ترمینال غیرفعال شده است. | 105 |
| ترمینال حذف شده است. | 106 |
| ترمینال تائید نشده است. | 107 |
| شماره سفارش غیرعددی ارسال شده است. | 109 |
| مبلغ تراکنش باید بیشتر از 10000 ریال باشد. | 113 |
| به دلیل بروزرسانی، موقتا امکان انجام تراکنش وجود ندارد. | 114 |
| شناسه پرداخت صحیح نیست. | 200 |
| پرداخت انجام نشده است. | 201 |
| پرداخت کنسل شده است یا خطایی در مراحل پرداخت رخ داده است. | 202 |
| آدرس بازگشت و یا آدرس درخواست کننده با دامنه ثبت شده یکی نیست. | 203 |
| آدرس آی پی هاست دامنه نامعتبر است. | 204 |
| خطایی در برقراری با سرور بانک رخ داده است. | 301 |
| ترمینال غیرفعال است. | 302 |