پرش به محتویات

استعلام تسهیلات بانکی

آدرس سرویس: POST https://..../carbon/v4.0/bank_service/inquiry/loan


شرح

این سرویس جهت استعلام تسهیلات بانکی مورد استفاده قرار می گیرد.

لیست مربوط به تسهیلات را نشان می دهد .


Headers

مقادیر زیر باید در هدر قرار بگیرد

  Authorization : Bearer {Token}
  clientAddress : client IP

توجه : برای دریافت توکن مربوطه به بخش سرویس توکن مراجعه فرمایید

توضیحات

  • Authorization: در این قسمت توکن دریافت شده از سرویس توکن را وارد نمایید
  • clientAddress: آی پی مشتری نهایی که سرویس را دریافت کرده است .

Parameters

  • request_number(نوع داده عددی) : (اجباری) این شناسه جهت پیگیری های بعدی مورد استفاده قرار می گیرد و پیشنهاد میگردد یه شناسه یکتا به ازای هر درخواست توسط سامانه مشتری تولید و به این سرویس ارسال گردد. سامانه ابری کربن هیچ کنترلی بر روی عدم تکراری بودن این مقدار انجام نمی دهد.

  • national_id (نوع داده عددی): (اجباری) کد ملی

نمونه درخواست:

curl --location 'https://..../carbon/v4.0/bank_service/inquiry/loan' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'clientAddress: xxx' \
--header 'Authorization: ••••••' \
--data '{
    "request_number":"....",
    "national_id":"...."
}'

جواب موفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "....",
    "tracking_number": "....",
    "request_number": "....",
    "result": {
        "national_id": "....",
        "name": "",
        "message": " تسهیلات و تعهدی یافت شد",
        "facility_list": [
            {
                "bank_code": "....",
                "branch_code": "....",
                "branch_description": "....",
                "past_expiration_amount": "....",
                "deferred_amount": "....",
                "suspicious_amount": "....",
                "debtor_total_amount": "....",
                "type": "....",
                "amount_orginal": "....",
                "benefit_amount": "....",
                "facility_bank_code": "....",
                "facility_branch_code": "....",
                "facility_branch": "....",
                "facility_request_number": "....",
                "facility_request_type": "....",
                "facility_currency_code": "....",
                "facility_past_expired_amount": "....",
                "facility_deferred_amount": "....",
                "facility_suspicious_amount": "....",
                "facility_debtor_total_amount": "....",
                "facility_type": "....",
                "facility_status": "....",
                "Facility_Amount_Orginal": "....",
                "facility_benefit_amount": "....",
                "facility_set_date": "....",
                "facility_end_date": "....",
                "facility_amount_obligation": "....",
                "facility_group": "....",
                "facility_moratorium_date": "....",
                "count": 1
            },
            {
                "bank_code": "....",
                "branch_code": "....",
                "branch_description": "....",
                "past_expiration_amount": "....",
                "deferred_amount": "....",
                "suspicious_amount": "....",
                "debtor_total_amount": "....",
                "type": "....",
                "amount_orginal": "....",
                "benefit_amount": "....",
                "facility_bank_code": "....",
                "facility_branch_code": "....",
                "facility_branch": "....",
                "facility_request_number": "....",
                "facility_request_type": "....",
                "facility_currency_code": "....",
                "facility_past_expired_amount": "....",
                "facility_deferred_amount": "....",
                "facility_suspicious_amount": "....",
                "facility_debtor_total_amount": "....",
                "facility_type": "....",
                "facility_status": "....",
                "Facility_Amount_Orginal": "....",
                "facility_benefit_amount": "....",
                "facility_set_date": "....",
                "facility_end_date": "....",
                "facility_amount_obligation": "....",
                "facility_group": "....",
                "facility_moratorium_date": "....",
                "count": 1
            }
            
            
        ],
        "facility_Total_Amount": "....",
        "facility_debt_total_amount": "....",
        "facility_past_expired_total_amount": "....",
        "facility_deferred_total_amount": "....",
        "facility_suspicious_total_amount": "....",
        "dishonored": ""
    },
    "transaction_details": {
        "available_wallet_balance": "98765000",
        "provider_name": "pertikan",
        "service_price": "....",
        "curency": "IRR",
        "remaining_number_of_calls": "950",
        "remaining_number_of_calls_day": "950"
    },
    "errors": {}
}

جواب ناموفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "....",
    "tracking_number": "....",
    "request_number": "....",
    "result": {
        "national_id": "....",
        "name": "",
        "message": " هیچ تسهیلات و تعهدی یافت نشد ",
        "facility_list": [],
        "facility_Total_Amount": "",
        "facility_debt_total_amount": "",
        "facility_past_expired_total_amount": "",
        "facility_deferred_total_amount": "",
        "facility_suspicious_total_amount": "",
        "dishonored": ""
    },
    "transaction_details": {
        "available_wallet_balance": "98765000",
        "provider_name": "pertikan",
        "service_price": "0",
        "curency": "IRR",
        "remaining_number_of_calls": "949",
        "remaining_number_of_calls_day": "949"
    },
    "errors": {}
}
  • status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد
  • message: پاسخ از طرف سرویس سامانه ابری کربن
  • timestamp: زمان و تاریخ درخواست
  • request_number: شماره پیگیری ارسال شده در زمان فراخوانی
  • tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
  • result: آبجکتی از پاسخ سرویس شامل:
  • national_id: کد ملی
  • name: نام شخص
  • message: پیام
  • bank_code: کد بانک
  • branch_code: کد شعبه
  • branch_description: توضیحات شعبه
  • past_expiration_amount: مبلغ انقضای گذشته
  • deferred_amount: مبلغ معوق
  • suspicious_amount: مقدار مشکوک
  • debtor_total_amount: مبلغ کل بدهکار
  • type: مدل
  • amount_orginal: مبلغ اصلی
  • benefit_amount: سود مبلغ
  • facility_bank_code: کد بانک تسهیلات
  • facility_branch_code: کد شعبه تسهیلات
  • facility_branch: شعبه تسهیلات
  • facility_request_number: شماره درخواست تسهیلات
  • facility_request_type: مدل درخواست تسهیلات
  • facility_currency_code: کد ارز تسهیلات
  • facility_past_expired_amount: مبلغ انقضا گذشته تسهیلات
  • facility_deferred_amount: مبلغ معوق تسهیلات
  • facility_suspicious_amount: مبلغ مشکوک تسهیلات
  • facility_debtor_total_amount: کل مبلغ بدهی تسهیلات
  • facility_type: مدل تسهیلات
  • facility_status: وضعیت تسهیلات
  • Facility_Amount_Orginal: مبلغ اصلی تسهیلات
  • facility_benefit_amount: مبلغ سود تسهیلات
  • facility_set_date: تاریخ تنظیم تسهیلات
  • facility_end_date: تاریخ پایان تسهیلات
  • facility_amount_obligation: مبلغ تعهد تسهیلات
  • facility_group: گروه تسهیلات
  • facility_moratorium_date: تاریسخ توقف موقت تسهیلات
  • count: شمارنده
  • service_price: قیمت سرویس
  • در صورت بروز خطا در درخواست :

  • errors: جزییات خطا
  • error_code: کد مربوط به خطایی که پیش آمده است
  • error_description: متن خطا
  • reference_name: اطلاعات تکمیلی خطا
  • original_value: اطلاعات تکمیلی خطا