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

تطبیق شماره شبا با کد ملی

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


شرح

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


Headers

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

  Authorization : Bearer {Token}
  clientAddress : client IP

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

توضیحات

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

Parameters

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

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

  • iban (نوع داده عددی) : (اجباری) شماره شبا

  • identifier_type (نوع داده عددی) : (اجباری) وضعیت حیات فرد به این صورت که در قید حیات باشد عدد صفر است و در صورت عدم حیات عدد 1 می باشد .

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

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

جواب موفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "2025-12-13 15:11:37.919",
    "tracking_number": "860215818",
    "request_number": "202508162015",
    "result": {
        "is_valid": "true"
    },
    "transaction_details": {
        "available_wallet_balance": "101646000",
        "provider_name": "Pertikan",
        "service_price": "....",
        "curency": "IRR",
        "remaining_number_of_calls": "998",
        "remaining_number_of_calls_day": "998"
    },
    "errors": {}
}

جواب ناموفق:

{
    "status": "1",
    "message": "تراکنش ناموفق",
    "timestamp": "2025-12-10 12:41:00.476",
    "tracking_number": "20251210124100474",
    "req_id": "202511122024",
    "result": {},
    "transaction_detials": {},
    "errors": {
        "error_code": "6001",
        "error_description": "invalid input parameter: national_id is not found ",
        "reference_name": "national_id",
        "original_value": ""
    }
}
  • status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد .
  • message: پاسخ از طرف سرویس سامانه ابری کربن
  • timestamp : زمان و تاریخ درخواست
  • request_number: شماره پیگیری ارسال شده در زمان فراخوانی
  • tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
  • result: آبجکتی از پاسخ سرویس شامل:
  • is_valid : شماره شبا و کد ملی تطابق دارند یا خیر که با true و false نمایش داده می شود .
  • errors: جزییات خطا
  • error_code: کد مربوط به خطایی که پیش آمده است
  • error_description: متن خطا
  • reference_name: اطلاعات تکمیلی خطا
  • original_value: اطلاعات تکمیلی خطا