مستندات API استعلام چک های برگشتی با جزئیات

مستندات API استعلام چک های برگشتی با جزئیات | راهنمای کامل استفاده

در این صفحه می‌توانید راهنمای کامل استفاده از API استعلام چک های برگشتی با جزئیات را مشاهده کنید. شامل پارامترهای ورودی، نمونه درخواست CURL، خروجی پاسخ، کدهای آماده و ویدئوی آموزشی برای درک بهتر عملکرد سرویس و استفاده آسان در پروژه‌های خود است. این مستندات به شما کمک می‌کند تا API را به‌صورت دقیق و سریع پیاده‌سازی کنید و از تمام قابلیت‌های سرویس بهره‌مند شوید.

📝 توضیحات سرویس

با استفاده از این وب سرویس می‌توانید تنها با ارسال کد ملی یا شناسه شرکت ، اطلاعات کامل شخص و لیست چک‌های برگشتی او را در پاسخ درخواست خود دریافت کنید. خروجی شامل جزئیاتی مانند کد بانک، نام شعبه صادرکننده و برگشت زننده، مبلغ چک، شیوه ارائه، تاریخ اعتبار و برگشت، شماره شبا، سریال، مبلغ برگشتی و دلیل برگشت چک می‌باشد. این سرویس برای بررسی سوابق مالی، مدیریت ریسک اعتباری، احراز هویت و تطبیق اطلاعات در سامانه‌های بانکی و سازمانی بسیار کاربردی و قابل اعتماد است.

🏷️ CURL

📡 POST api/v2/inquiry_returned_cheques

curl --location 'https://shabanic.ir/api/v2/inquiry_returned_cheques' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_SHABANIC_API_KEY}' \
--data '{
    "nationalId": "{YOUR_NATIONAL_ID}"
}'

📌 ورودی های سرویس

🗂️ JSON Inputs

{
    "nationalId": "{YOUR_NATIONAL_ID}"
}

📤 خروجی سرویس

🧾 JSON Response

{
    "success": true, ----------------------------------> وضعیت کلی درخواست
    "trackId": "shabanic-69de7925e45085.19196257", ----------------------------------> ترک آی دی شبانیک
    "message": null, ----------------------------------> اگر پیغام خطا داشته باشد
    "result": { ----------------------------------> آبجکت اصلی پاسخ شبانیک
        "firstName": "متین", ----------------------------------> نام
        "lastName": "ولی نژاد", ----------------------------------> نام خانوادگی
        "nationalId": "0040123456", ----------------------------------> کد ملی
        "personType": 1, ----------------------------------> نوع مشتری
        "isValid": true, ----------------------------------> وضعیت اعتبار
        "cheques":
        [ {
            "bankCode": 17,    ----------------------------------> کد بانک
            "bouncedBranchName" : " ",    -------------->  نام شعبه برگشت زننده
            "amount": 25000000,    ----------------------------> مبلغ چک
            "channelKind": 2,    ----------------------------> شیوه ارائه چک
            "deadlineDate": "14031201",    ------------------->تاریخ اعتبار چک
            "originBranchName" : " ", ----------------> نام شعبه باز کننده حساب
            "bouncedReason": [ 402, 404 ],   -------------> دلیل برگشت چک
            "bouncedAmount": *,   --------------------------> مبلغ برگشتی
            "branchBounced": "*",   ----------------------> شعبه برگشت زننده
            "customerType": 1,   -----------------------------> نوع کاربری
            "idCheque": *,   -------------------------------> رهگیری چک
            "serial": "* ",
            "iban": "*",    ----------------------------------------->شبا
            "bouncedDate": "14031202",   --------------------->تاریخ برگشت
            "currencyRate": 1,
            "currencyCode": "IRR",
            "branchOrigin": "*"
        } ]
        "requestInfo": "66460601"
    },
    "statusCode": 200
}


{
	"success": false,
	"error_code": "FN-BRFH-50000040816",
	"message": "پیغام مرتبط با خطا",
	"trackId": "shabanic-699dcc859daf40.50355751"
}

برای پیگیری خطا کافیست مقدار trackId را به پشتیبانی شبانیک بدهید.

ℹ️ توضیحات سرویس استعلام چک های برگشتی با جزئیات

این سرویس برای استعلام چک های برگشتی با جزئیات استفاده می‌شود. در ادامه مشخصات کامل درخواست و پاسخ را مشاهده می‌کنید.

ورودی‌ها (Parameters)

nationalId — کد ملی یا شناسه ملی شرکت (کدملی 10 رقم، شناسه ملی شرکت 11 رقم)

خروجی‌ها (Response)

success — وضعیت کلی درخواست
trackId — ترک آی دی شبانیک
message — متن خطا در صورت ناموفق بودن درخواست
result — آبجکت اصلی پاسخ شبانیک
firstName — نام
lastName — نام خانوادگی
nationalId — کد ملی
personType — نوع مشتری (حقیقی 1 ، حقوقی 2)
isValid — وضعیت اعتبار
cheques — حاوی مشخصات آرایه ای از چک های برگشت
bankCode — کد بانک
bouncedBranchName — نام شعبه برگشت زننده
amount — مبلغ چک
channelKind — شیوه ارائه چک (1: چکاوک 2: مراجعه به بانک)
deadlineDate — اعتبار چک
originBranchName — نام شعبه باز کننده حساب
bouncedReason — دلیل برگشت چک
bouncedAmount — مبلغ برگشتی
branchBounced — شعبه برگشت زننده
customerType — نوع مشتری (حقیقی 1 ، حقوقی 2)
idCheque — رهگیری چک
serial — سریال
iban — شماره شبا
bouncedDate — تاریخ برگشت چک
currencyRate — اولویت ارزی چک
currencyCode — علامت اختصاری ارز چک
branchOrigin — شعبه صدور دسته چک
requestInfo — کد رهگیری
statusCode — وضعیت درخواست

کاربرد های این Api

نکات مهم

فعال‌سازی API شبانیک — برای شروع استفاده از APIهای شبانیک، ابتدا پروفایل خود را تکمیل کنید (مشاهده پروفایل) و سپس با پشتیبانی مستقیم شبانیک (09156012679) برای صدور مجوز و دریافت توکن اقدام نمایید.
توکن شبانیک — پس از دریافت مجوز، توکن خود را به‌عنوان Bearer در هدر درخواست‌ها قرار دهید.

🎬 ویدئوی آموزشی API استعلام چک های برگشتی با جزئیات

در این ویدئو نحوه فراخوانی API استعلام چک های برگشتی با جزئیات از سامانه شبانیک توضیح داده شده است.

💻 دانلود نمونه کدهای API استعلام چک های برگشتی با جزئیات

در این بخش می‌توانید نمونه کدهای آماده برای فراخوانی API استعلام چک های برگشتی با جزئیات شبانیک به زبان‌های PHP (Laravel)، JavaScript (Node.js)، Python، Java، Kotlin، C# (.NET) و cURL را دانلود کرده و مستقیماً در پروژه خود استفاده کنید.

نمونه کد PHP (Laravel) برای فراخوانی API استعلام چک های برگشتی با جزئیات

دانلود فایل PHP

نمونه کد JavaScript (Node.js) برای استفاده از API استعلام چک های برگشتی با جزئیات

دانلود فایل JavaScript

نمونه کد Python برای اتصال به API استعلام چک های برگشتی با جزئیات شبانیک

دانلود فایل Python

نمونه کد Java (اندروید) برای فراخوانی API استعلام چک های برگشتی با جزئیات

دانلود فایل Java

نمونه کد Kotlin برای استفاده از API استعلام چک های برگشتی با جزئیات در اپلیکیشن موبایل

دانلود فایل Kotlin

نمونه کد C# (.NET) برای اتصال به API استعلام چک های برگشتی با جزئیات

دانلود فایل C#

نمونه درخواست cURL برای تست API استعلام چک های برگشتی با جزئیات

دانلود فایل cURL

دانلود همه نمونه کدهای API این سرویس به صورت (ZIP)

❓ سوالات متداول (FAQ)

پاسخ به سوالات رایج در استفاده از سرویس استعلام چک های برگشتی با جزئیات.

:دلیل برگشت چک 402 : کمبود موجودی 403 : نبود موجودی 404 : ناهمخوانی امضا 405 : نقص امضا 406: ناهمخوانی تاریخ عددی و حروفی 407 : مخدوشی امضا 408 : مخدوشی مندرجات امضا 409: ناهمخوانی مبلغ حروفی با عددی 410: حساب بسته است 411 : حساب مسدود است 412 : چک با این شماره مسدود است

1 : چکاوک 2 : مراجعه به بانک

1 : دارنده حساب 2 : امضا کننده 3 : ذینفع

آماده‌اید به ساده‌ترین شکل ممکن، API «استعلام چک های برگشتی با جزئیات» را از شبانیک دریافت کنید؟

تنها در چند مرحله ساده، کلید اختصاصی API خود را دریافت کرده و سرویس استعلام چک های برگشتی با جزئیات را در پروژه خود فعال کنید.

رفتن به پنل توسعه‌دهندگان

Shabanic Postman

سرویس های پرکاربرد