استعلام چک صیاد توسط دارنده

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

---

شرح

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

---

Headers

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

  Authorization : Bearer {Token}
  clientAddress : client IP

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

توضیحات

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

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

Parameters

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

• sayad_id (نوع داده عددی) : (اجباری) شناسه چک صیادی

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

• identifier_type (نوع داده عددی) : (اجباری) مدل دارنده که عبارت است از عدد 1 برای شخص حقیقی و 2 برای حقوقی و 3 برای اتباع بیگانه حقیقی و 4 برای اتباع بیگانه حقوقی

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

curl --location --request POST '/carbon/v4.0/bank_service/inquiry/holde_cheque'\
--header 'Authorization: Bearer ....'\
--header 'Content-Type: application/json'\
--data-raw '{
    "request_number": "....",
    "sayad_id": "....",
    "national_id": "....",
    "identifier_type": "...."
}'

جواب موفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "....",
    "tracking_number": "....",
    "request_number": "....",
    "result": {
        "holders": {
            "name": "....",
            "idCode": "....",
            "idTypes": "...."
        },
        "signers": {
            "legalStamps": "....",
            "name": ".... "
        },
        "cheque_type": "....",
        "serial_number": "....",
        "amount": "....",
        "date": "....",
        "description": "....",
        "from_iban": "....",
        "branch_code": "....",
        "cheque_status": "....",
        "reason": "....",
        "guarantee_status": "....",
        "block_status": "....",
        "bank_code": "...."
    },
    "transaction_details": {
        "available_wallet_balance": "98765000",
        "provider_name": "pertikan",
        "service_price": "0",
        "curency": "IRR",
        "remaining_number_of_calls": "993",
        "remaining_number_of_calls_day": "993"
    },
    "errors": {}
}

جواب ناموفق:

{
    "status": "1",
    "message": "تراکنش ناموفق",
    "timestamp": "....",
    "tracking_number": "....",
    "request_number": "....",
    "result": {},
    "transaction_details": {},
    "errors": {
        "error_code": "5002",
        "error_description": "Transaction failed : Provider  Error",
        "reference_name": "47_",
        "original_value": ""
    }
}

• status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد
• message: پاسخ از طرف سرویس سامانه ابری کربن
• timestamp: زمان و تاریخ درخواست
• request_number: شماره پیگیری ارسال شده در زمان فراخوانی
• tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
• result: آبجکتی از پاسخ سرویس شامل:
• holders: دانرنده چک
• signers: امضا کنندگان
• cheque_type: مدل چک
• serial_number: شماره سریال چک
• amount: مبلغ چک
• date: تاریخ چک
• description: توضیحات
• from_iban: از شماره شبا
• branch_code: کد شعبه
• cheque_status: وضعیت چک
• reason: دلیل
• guarantee_status: وضعیت گارانتی
• block_status: وضعیت بلاک
• bank_code: کد بانک
• service_price: قیمت سرویس

در صورت بروز خطا در درخواست :

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

---