401عدم احراز هویت
کلید API معتبر نیست یا ارسال نشده است. اعتبارنامه را بررسی کنید.
در حال بارگذاری...
در حال بارگذاری...
راهنمای توسعهدهندگان بانکی پِی برای شروع سریع، احراز هویت، استفاده از محیط تست، مدیریت خطاها و رعایت نکات امنیتی در اتصال به وبسرویسهای بانکی و مالی.
اگر تازه شروع کردهاید، از شروع سریع و احراز هویت آغاز کنید؛ سپس endpointها، خطاها و نکات امنیتی را بررسی کنید.
این مسیر برای کاهش خطای پیادهسازی، حفظ امنیت اعتبارنامهها و آمادهسازی سرویس برای مصرف واقعی طراحی شده است.
پس از ثبتنام و تکمیل احراز، کلید API و دسترسی Sandbox را از پنل دریافت کنید.
با نمونه endpointها در محیط Sandbox شروع کنید و پاسخ JSON، کد خطا و زمان پاسخ را بررسی کنید.
کلیدها را محرمانه نگه دارید، IP مجاز را تنظیم کنید و از ارسال داده حساس در URL خودداری کنید.
پس از تست موفق، کلید Production را فعال کرده و Request ID و پایش خطا را در سیستم خود ثبت کنید.
هر درخواست باید با اعتبارنامه معتبر ارسال شود. کلید API را مانند رمز عبور در نظر بگیرید و فقط در سمت سرور یا محیط امن نگهداری کنید.
نمونه header
curl -X POST https://api.bpey.ir/v1/card-to-iban \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"request_id":"req_123456789"}'| متد | مسیر | سرویس | کاربرد |
|---|---|---|---|
| POST | /v1/card-to-iban | تبدیل کارت به شبا استعلام بانکی | دریافت شماره شبا، نام صاحب حساب و بانک مقصد از روی شماره کارت. |
| POST | /v1/card-to-account | تبدیل کارت به حساب استعلام بانکی | دریافت شماره حساب و نام صاحب حساب از روی شماره کارت. |
| POST | /v1/iban-info | اطلاعات شبا استعلام بانکی | دریافت اطلاعات کامل شبا شامل نام بانک، شماره حساب و صاحب حساب. |
| POST | /v1/account-to-iban | تبدیل حساب به شبا استعلام بانکی | تبدیل شماره حساب و کد بانک به شماره شبا. |
| POST | /v1/payment/create | ایجاد پرداخت پرداخت | ایجاد درخواست پرداخت و دریافت لینک درگاه. |
| GET | /v1/transactions | گزارش تراکنش گزارشگیری | دریافت لیست تراکنشها با امکان فیلتر بر اساس تاریخ و وضعیت. |
Sample Request
{
"request_id": "req_123456789",
"card_number": "6037991100000000",
"national_id": "0012345678"
}Sample Response
{
"status": "success",
"request_id": "req_123456789",
"data": {
"iban": "IR062960000000100324200001",
"bank_name": "بانک نمونه",
"account_owner": "علی رضایی"
}
}پاسخهای خطا معمولاً شامل کد خطا، پیام خطا و شناسه درخواست هستند. این اطلاعات برای عیبیابی و تماس با پشتیبانی ضروری است.
401کلید API معتبر نیست یا ارسال نشده است. اعتبارنامه را بررسی کنید.
403کلید API فاقد دسترسی به این endpoint است. مجوزها را بررسی کنید.
429تعداد درخواستها بیش از حد مجاز است. فاصله بین درخواستها را افزایش دهید.
500خطای داخلی سرور. Request ID را برای پیگیری ذخیره کنید.
این موارد عمومی و ضروری هستند و باید پیش از انتقال به محیط عملیاتی بررسی شوند. برای الزامات خاص هر سرویس، مستندات پنل و پشتیبانی را ملاک قرار دهید.
بله. پس از ثبتنام و تکمیل اطلاعات، کلید API و دسترسی Sandbox برای شما فعال میشود.
خیر. کلیدهای API باید در سمت سرور یا محیط امن نگهداری شوند و از انتشار آنها در مرورگر، اپ موبایل یا ریپازیتوری عمومی جلوگیری شود.
اگر در انتخاب سرویس، احراز هویت یا سناریوی اتصال سوال دارید، تیم پشتیبانی فنی بانکی پِی آماده راهنمایی شماست.