خانه راهنمای استفاده مستندات API

# استعلام شماره شبا

این سرویس برای استعلام شماره شبا استفاده می‌شود. درخواست را با توکن معتبر ارسال کنید و نتیجه را در فیلد data پاسخ بخوانید.

:::

# ارسال اطلاعات

برای استفاده از این سرویس، پارامترهای زیر را با متد POST به آدرس مشخص‌شده ارسال کنید.

نام نوع الزامی توضیحات
iban رشته بله شماره شبا
نکته

تمامی داده‌های برگشتی از API به صورت JSON هستند.

# آدرس سرویس 

https://zarin-hub.com/api/v5/KYC/IbanInquiry

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

  • PHP
  • Python
  • Java
  • Node.js
  • Go
  • cURL
  • C# 
<?php
$curl = curl_init('https://zarin-hub.com/api/v5/KYC/IbanInquiry');

curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer {ACCESS_TOKEN}',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{"iban":"IR820540102680020817909002"}',
]);

$response = curl_exec($curl);
curl_close($curl);

# پاسخ سرویس

پارامترهای پاسخ این سرویس:

نام نوع الزامی توضیحات
data شیء خیر داده پاسخ
meta شیء خیر اطلاعات پردازش
meta.code عدد صحیح خیر کد وضعیت
meta.errorMessage رشته خیر پیام خطا
meta.errorType رشته خیر enum name, null on success
meta.errors آرایه<شیء> خیر خطاها
meta.isSuccess بولی خیر موفقیت درخواست
meta.message رشته خیر پیام
meta.status رشته خیر وضعیت
meta.trackId رشته خیر شناسه پیگیری
data.bankName رشته خیر نام بانک
data.deposit رشته خیر شماره حساب
data.depositComment رشته خیر —
data.depositDescription رشته خیر —
data.depositOwners آرایه<شیء> خیر —
data.depositStatus رشته خیر —
data.englishBankName رشته خیر —
data.errorDescription رشته خیر —
data.iban رشته خیر شماره شبا

نمونه پاسخ موفق:

{
  "data": {
    "bankName": "bankName_value",
    "deposit": "0101234567001",
    "depositComment": "depositComment_value",
    "depositDescription": "depositDescription_value",
    "depositOwners": [
      {}
    ],
    "depositStatus": "depositStatus_value",
    "englishBankName": "englishBankName_value",
    "errorDescription": "errorDescription_value",
    "iban": "IR820540102680020817909002"
  },
  "meta": {
    "code": 0,
    "errorMessage": null,
    "errorType": null,
    "errors": [],
    "isSuccess": true,
    "message": "عملیات با موفقیت انجام شد",
    "status": "success",
    "trackId": "9b126e9a-184c-4cb0-a47e-62b9a3b7176f"
  }
}

نمونه پاسخ ناموفق:

{
  "data": {},
  "meta": {
    "trackId": null,
    "status": "error",
    "isSuccess": false,
    "code": -1,
    "message": "درخواست ناموفق بود",
    "errorMessage": "پارامترهای درخواست نامعتبر هستند",
    "errorType": "validation_error",
    "errors": []
  }
}

قبلی

دریافت تصویر کارت ملی

بعدی

تطبیق نام صاحب شبا