استعلام موجودی حساب

آدرس سرویس: POST https:/carbon/v4.0/bank_service/account/get_balance

---

شرح

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

---

Headers

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

  Authorization : Bearer {Token}
  clientAddress : client IP

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

توضیحات

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

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

Parameters

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

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

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

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

curl --location --request POST 'https:/carbon/v4.0/bank_service/account/get_balance' \
--header 'Authorization:Bearer ....' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bank_name": "sepah",
    "request_number": ....,
    "deposit_number": "...."
}

جواب موفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "2026-01-13 11:09:54.308",
    "tracking_number": "343",
    "request_number": "202508162015",
    "result": {
        "deposit_number": "....",
        "balance": "....",
        "blocked_balance": "....",
        "available_balance": "...."
    },
    "transaction_details": {
        "available_wallet_balance": "200000000",
        "provider_name": "Pertikan",
        "service_price": "....",
        "curency": "IRR",
        "remaining_number_of_calls": "925",
        "remaining_number_of_calls_day": "925"
    },
    "errors": {}
}

جواب ناموفق:

{
    "status": "1",
    "message": "تراکنش ناموفق",
    "timestamp": "2026-01-13 11:10:14.839",
    "tracking_number": "346",
    "request_number": "202508162015",
    "result": {},
    "transaction_details": {},
    "errors": {
        "error_code": "10002",
        "error_description": "Transaction failed : Provider  Error",
        "reference_name": "49_",
        "original_value": "ServiceAccessIsDeniedWSException: {The deposit is not in Source White Deposit List.} "
    }
}

• status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد
• message: پاسخ از طرف سرویس سامانه ابری کربن
• timestamp : زمان و تاریخ درخواست
• request_number: شماره پیگیری ارسال شده در زمان فراخوانی
• tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
• result: آبجکتی از پاسخ سرویس شامل:
• deposit_number : شماره حساب
• balance : مقدار موجودی
• blocked_balance: موجودی بلاک شده
• available_balance: مقدار موجودی مجاز استفاده

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

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

---