مقدمه

API های وندار بر اساس استاندارد REST ایجاد شده اند.

تمامی API ها بصورت JSON-encoded پاسخ داده خواهند شد.

بوسیله ارسال توکن در هر درخواست، احراز هویت نیز انجام می شود. (ممکن است در برخی از سرویس ها نحوه احراز هویت متفاوت باشد)

آیا این بخش مفید بود؟بلی خیر

https://api.vandar.io

تمدید توکن

دریافت توکن اولیه کسب و کار از طریق داشبورد وندار و تنها با دسترسی مالک یا مدیر کسب و کار امکانپذیر می‌باشد. جهت دریافت توکن از داشبورد، وارد منوی تنظیمات، بخش توکن‌ها شوید. با زدن دکمه دریافت توکن جدید، یک نام برای توکن ثبت کرده و رمز عبور حساب کاربری خود در وندار را وارد نمایید، در پاسخ توکن و رفرش توکن به شما برگردانده می‌شود.

در حال حاضر عمر توکن‌ها ۵ روز و عمر رفرش توکن ۱۰ روز می‌باشد و لازم است قبل از منقضی شدن توکن اقدام به تمدید توکن نموده و توکن و رفرش توکن جدید را جایگزین نمایید.

پارامترها

refreshtokenrequiredstring

مقدار رفرش توکن که از پاسخ دریافتی از داشبورد و یا فراخوانی سرویس تمدید توکن دریافت نموده‌اید

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/refreshtoken',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    refreshtoken: '{refreshtoken}'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "token_type": "Bearer",
  "expires_in": 432000,
  "access_token": "bPJO9cJLGRqClDadEua7ztoCLC5E***********",
  "refresh_token": "def50200c4d2462d2de167da1*******"
}

کالکشن Postman

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

کلیه سرویس‌های وندار در کالکشن ارائه شده موجود می‌باشد، برای تست API ها کافیست نام انگلیسی کسب‌وکار خود را بجای پارامتر business و اکسس توکن دریافتی از وندار را در پارامتر access_token ارسال نمائید.

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

آیا این بخش مفید بود؟بلی خیر

vandar_postman_collection

خطاها

API های وندار از قواعد REST پیروی می‌کند.

بطور کلی در رنج 2xx پاسخ های موفق را دریافت می‌کنید.

رنج 4xx زمانی بوجود می‌آید که اطلاعات اشتباهی از سمت شما به API ها ارسال شده است.

خطاهایی در رنج 5xx نشان دهنده مشکلاتی از سمت API های وندار بوده که می توانید آن را با پشتیبانی مطرح کنید.

آیا این بخش مفید بود؟بلی خیر

200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
402 - Request Failed	The parameters were valid but the request failed.
403 - Forbidden	The API key doesn't have permissions to perform the request.

کسب و کار

با استفاده از این بخش می‌توانید اطلاعات کسب‌وکار و لیست کاربران کسب‌وکار خود را مشاهده کنید.

آیا این بخش مفید بود؟بلی خیر

GET /v2/business/:business

GET /v2/business/:business/iam

صورت حساب

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

آیا این بخش مفید بود؟بلی خیر

GET /v2/business/:business/balance

GET /v3/business/:business/transaction

درگاه پرداخت IPG

برای فروشگاه‌های اینترنتی که خدمات یا محصولاتی را در وب‌سـایت خود ارائه می‌کنند، از درگاه پرداخت وندار استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

POST https://ipg.vandar.io/api/v4/send

GET https://ipg.vandar.io/v4/:token

POST https://ipg.vandar.io/api/v4/transaction

POST https://ipg.vandar.io/api/v4/verify

بازگشت وجه

از سرویس بازگشت وجه می‌توانید برای بازگرداندن مبلغ یک تراکنشِ موفقِ درگاه پرداخت، به شماره کارت پرداخت‌کننده استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/transaction/:transaction_id/refund

تسویه

با استفاده از سرویس تسویه می‌توانید مبلغ موردنظر از کیف پول کسب و کار خود به مقصد شبای دلخواه (تمامی شباهای سامانه بانکی کشور) واریز نمائید.

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/settlement/store

GET /v2.1/business/:business/settlement

GET /v2.1/business/:business/settlement/:settlement_id

DELETE /v2.1/business/:business/settlement/:transaction_id

GET /v3/business/:business/settlement/banks

تسویه گروهی

با استفاده از سرویس تسویه گروهی می‌توانید تسویه های خود به صورت دسته ای (گروهی) یکجا ثبت نمائید.

آیا این بخش مفید بود؟بلی خیر

POST https://batch.vandar.io/api/v2/business/:business/batches-settlement

GET https://batch.vandar.io/api/v2/business/:business/batches

GET https://batch.vandar.io/api/v2/business/:business/batch-settlements/:batch_id

تسویه در نوبت

با استفاده از سرویس تسویه در نوبت می‌توانید هنگامی که کیف پول شما به اندازه کافی موجودی ندارد، تسویه های خود ثبت نمائید و پس از اینکه کیف پول شما افزایش پیدا کرد این تسویه‌ها به بانک ارسال می‌شود.

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/settlement/queued

GET /v3/business/:business/settlement/queued

GET /v3/business/:business/settlement/queued/:id

POST /v3/business/:business/settlement/queued/cancel

آوند

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

آیا این بخش مفید بود؟بلی خیر

عملیات حساب

امکان دریافت موجودی حساب‌ها، مشاهده لیست تراکنش‌ها، و ثبت تسویه برای حساب‌های شما فراهم است.

آیا این بخش مفید بود؟بلی خیر

GET /v3/business/:business/settlement/account/:iban/last-balance

GET /v3/business/:business/settlement/account/statement

واریز شناسه‌دار

«واریز شناسه‌دار»، سرویس مکمل سایر روش‌های پرداخت است که افراد و سازمان‌ها از آن استفاده می‌کنند. به کمک این سرویس، می‌توانید بدون محدودیت در شبکه بانکی، پرداخت و دریافت وجه داشته باشید. این سرویس به صورت پیشفرض برای همه کسب‌وکارهای فعال، قابل استفاده بوده و برای هر کسب‌وکار یک شناسه یکتا منحصر به فرد تخصیص می‌یابد. با استفاده از «واریز شناسه‌دار» این امکان وجود دارد که با واریز وجه از همه بانک‌هایی که در آن حساب دارید، موجودی «کیف پول وندار» خود را افزایش دهید.

آیا این بخش مفید بود؟بلی خیر

GET /v3/business/:business/cash-in/code

GET /v3/business/:business/cash-in/pic/transactions

GET /v3/business/:business/cash-in/suspicious-payment

POST /v3/business/:business/cash-in/suspicious-payment/:id

ابزار واریز بانکی

ابزار «واریز بانکی» یا به اصطلاح ،cash in یکی از بهترین روش‌های شارژ کیف پول کسب‌وکار ها است. کسب‌ و کارهایی که مبالغ زیادی از حساب آن‌ها برداشته می‌شود، با استفاده از این ویژگی می‌توانند مبلغی را از حساب بانک آینده خود به کیف پول خود در وندار اضافه کرده و پس از آن تعیین کنند که چه مقدار وجه از کیف پول‌شان خارج شود.

آیا این بخش مفید بود؟بلی خیر

GET /v3/business/:business/cash-in/account

POST /v3/business/:business/cash-in/account/deposit

POST /v3/business/:business/cash-in/account/balance

پرداخت خودکار

سرویس پرداخت خودکار یا دایرکت دبیت سرویسی است که یک فرد وجوهی را از حساب بانکی شخص دیگری خارج می کند در واقع شما به بانک اجازه می دهید که مبلغی را مستقیما از حسابتان کسر و در قبال آن خدماتی را به شما ارایه دهد. به طور کلی دایرکت دبیت برداشت مستقیم پول برای انجام معاملات مالی در صورت صدور مجوز توسط پرداخت کننده می باشد. این کار بیشتر زمانی انجام می شود که شما بخواهید اشتراک خود را تمدید کنید.

آیا این بخش مفید بود؟بلی خیر

بانک‌ها

لیست بانک‌های فعال دایرکت‌دبیت برای کسب‌وکار شما از طریق این سرویس قابل دسترس می‌باشد. همچنین امکان مدیریت بانک‌ها در داشبورد وندار، بخش پرداخت خودکار فراهم می‌باشد.

آیا این بخش مفید بود؟بلی خیر

GET /v3/business/:business/subscription/banks/actives

مجوز پرداخت از حساب

جهت دسترسی به حساب در سرویس پرداخت خودکار، نیاز به ایجاد یک مجوز در بانک وجود دارد. بر اساس این مجوز، کسب‌وکار شما اجازه برداشت از حساب کاربر را خواهد داشت.

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/subscription/authorization/store

GET https://subscription.vandar.io/authorizations/:token

PATCH /v3/business/:business/subscription/authorization/:authorization_id/verify

GET /v3/business/:business/subscription/authorization/:authorization_id/search

GET /v3/business/:business/subscription/authorization

GET /v3/business/:business/subscription/authorization/:authorization_id/calculation

DELETE /v3/business/:business/subscription/authorization/:authorization_id

پرداخت از حساب

در این سرویس می‌توانید از حساب کاربران خود یکبار یا به صورت دوره‌ای بر اساس مجوزی که از کاربر گرفته‌اید، وجهی را برداشت نمایید.

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/subscription/withdrawal/store

GET /v3/business/:business/subscription/withdrawal/:withdrawal_id

GET /v3/business/:business/subscription/withdrawal/track-id/:track_id

GET /v3/business/:business/subscription/withdrawal

GET /v3/business/:business/subscription/withdrawal?q=:authorization_id

PUT /v3/business/:business/subscription/withdrawal/:withdrawal_id

بازگشت وجه

جهت بازگشت وجه یک تراکنش موفق پرداخت از حساب، می‌توانید از این سرویس استفاده نمایید.

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/subscription/refunds

GET /v3/business/:business/subscription/refunds/:refund_id

GET /v3/business/:business/subscription/refunds

مشتریان

در این بخش سرویس‌های ثبت مشتری، فیلدهای اختصاصی مشتری، مشاهده لیست مشتریان، ویرایش اطلاعات مشتری، حذف مشتری و مشاهده اطلاعات یک مشتری ارائه می‌شوند.

آیا این بخش مفید بود؟بلی خیر

GET /v2/business/:business/customers

POST /v2/business/:business/customers

PUT /v2/business/:business/customers/:customer

DELETE /v2/business/:business/customers/:customer

GET /v2/business/:business/customers/:customer

فیلد اختصاصی

با استفاده از این سرویس می‌توانید فیلدهای اختصاصی برای کسب و کار ثبت نمایید.

آیا این بخش مفید بود؟بلی خیر

GET /v2/business/business/customers/fields

POST /v2/business/:business/customers/fields

PUT /v2/business/:business/customers/fields/:field_id

DELETE /v2/business/:business/customers/fields/:field_id

GET /v2/business/:business/customers/fields/:field_id

کیف پول

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

آیا این بخش مفید بود؟بلی خیر

GET /v2/business/:business/customers/:customer/wallet

POST /v2/business/:business/customers/:customer/wallet/deposit

POST /v2/business/:business/customers/:customer/wallet/withdraw

تراکنش‌ها

در این بخش اطلاعات تراکنش‌های مشتریان قابل مشاهده می‌باشد.

آیا این بخش مفید بود؟بلی خیر

POST /v2/business/:business/customers/:customer/transactions

احراز هویت

این سرویس جهت احراز هویت طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان می‌توانند اطلاعات هویتی مخاطبان خود را مورد سنجش قرار دهند.

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/customers/:customer/authentication/kyc

POST /v3/business/:business/customers/:customer/authentication/shahkar

شناسه واریز

این سرویس جهت ایجاد شناسه واریز و انتصاب آن به طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان می‌توانند به ازای هر مشتری یک شناسه واریز منحصر به فرد ایجاد کنند.

آیا این بخش مفید بود؟بلی خیر

GET /v3/business/:business/customers/:customer/cash-in-code

شبا

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/customers/:customer/ibans

GET /v3/business/:business/customers/:customer/ibans

DELETE /v3/business/:business/customers/:customer/ibans

POST /v3/business/:business/customers/:customer/ibans/:iban/inquiry

POST /v3/business/:business/customers/:customer/ibans/:iban/set-default

کارت

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/customers/:customer/cards

GET /v3/business/:business/customers/:customer/cards

DELETE /v3/business/:business/customers/:customer/cards/:card

POST /v3/business/:business/customers/:customer/cards/:card/inquiry

POST /v3/business/:business/customers/:customer/cards/:card/set-default

POST /v3/business/:business/customers/:customer/cards/to-iban

گزارشات

این سرویس جهت گزارش گیری از طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان می‌توانند گزارش های مربوط به مخاطبان خود را مشاهده کنند.

آیا این بخش مفید بود؟بلی خیر

GET /v2/business/:business/customers/:customer/logs

استعلام ها

سرویس های استعلامی

آیا این بخش مفید بود؟بلی خیر

POST /v3/business/:business/customers/inquiry/kyc

POST /v3/business/:business/customers/inquiry/shahkar

POST /v3/business/:business/customers/inquiry/nid

POST /v3/business/:business/customers/inquiry/nid-image

POST /v3/business/:business/customers/inquiry/fida

POST /v3/business/:business/customers/inquiry/postal-code

POST /v3/business/:business/customers/inquiry/company-information

POST /v3/business/:business/customers/inquiry/company-signature

POST /v3/business/:business/customers/inquiry/national-code-iban

POST /v3/business/:business/customers/inquiry/match-mobile-card

POST /v3/business/:business/customers/inquiry/iban

POST /v3/business/:business/customers/inquiry/card

KYC

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

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار است

first_namerequiredstring

نام مخاطب

last_namerequiredstring

نام خانوادگی مخاطب

national_coderequiredstring

کد ملی مخاطب

birthdayrequiredstring

تاریخ تولد جلالی مخاطب

پاسخ ها

similarity_percentageinteger

درصد میزان تطابق

messagestring

شرح پیام

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/kyc',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: 'محمد',
    last_name: 'مقصودی',
    national_code: '0123456789',
    birthday: 13500101
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "similarity_percentage": 80
  }
}

شاهکار

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

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار است

national_coderequiredstring

کد ملی مخاطب

mobilerequiredstring

شماره تلفن همراه مخاطب

پاسخ ها

در صورت تطابق اطلاعات، وضعیت پاسخ ۲۰۰ و در غیر اینصورت ۴۰۰ با کد UNMATCHED برگردانده می‌شود

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/shahkar',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    mobile: '09121234567',
    national_code: '0123456789'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": []
}

{
  "message": "عدم تطابق اطلاعات",
  "data": [],
  "code": "UNMATCHED",
  "errors": null
}

استعلام هویت براساس کدملی

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

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

national_coderequiredstring

کدملی

birth_daterequiredinteger

تاریخ تولد که بصورت پشت سرهم باید نوشته شود

inquiry_typeoptionalstring

ارسال مقدار نوع استعلام، اختیاری بوده و بر اساس نیاز کسب و کار، این سرویس در دو حالت normal و extreme ارائه می‌شود. حالت پیش فرض، حالت normal است که پایداری بالا با کمترین نرخ خطا را فراهم می‌کند و برای تعداد فراخوانی زیاد مناسب است. در حالت extreme اطلاعات حالت نرمال به همراه تصویر کاربر با پایداری کمتر و نرخ خطا بالاتر ارائه می‌شود و برای تعداد فراخوانی کم مناسب است.

پاسخ ها

در صورت انطباق شماره ملی و تاریخ تولد پاسخ 200 و در صورت عدم انطباق پاسخ 400 برگشت داده می شود. همچنین در صورتی که ثبت احوال دچار اختلال باشد در پاسخ خطای 502 برمیگردد.

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/nid',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    national_code: '0123456789',
    birth_date: 13820214,
    inquiry_type: 'normal'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "national_code": "0123456789",
    "birth_date": "1382/02/14",
    "first_name": "علی",
    "last_name": "فراهانی",
    "father_name": "محمد",
    "aliveness": "alive",
    "gender": "male",
    "birth_place": "تهران",
    "register_place": "تهران - تهران",
    "register_no": "0",
    "register_series": "18ب",
    "register_serial": "596807",
    "images": [
      {
        "type": "Card",
        "image": "data:image",
        "error_code": null
      },
      {
        "type": "Cert",
        "image": null,
        "error_code": "image_not_found"
      }
    ]
  }
}

{
    "message": "تاریخ تولد متعلق به این کد ملی نیست",
    "data": [],
    "code": "NATIONAL_CODE_AND_BIRTH_DATE_DOES_NOT_MATCH",
    "errors": null
}

{
    "message": "خطای سرویس خارجی",
    "data": [],
    "code": "PROVIDER_ERROR",
    "errors": null
}

استعلام تصویر پرسنلی کارت ملی

استعلام تصویر کاربران براساس کدملی و تاریخ تولد انجام می شود.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

national_coderequiredstring

کدملی

birth_daterequiredinteger

تاریخ تولد که بصورت پشت سرهم باید نوشته شود

پاسخ ها

در صورت وجود تصویر کاربر در ثبت احوال پاسخ 200 و در صورت عدم وجود پاسخ 200 به همراه خطای image_not_found برگشت داده می شود. همچنین در صورتی که ثبت احوال دچار اختلال باشد در پاسخ خطای 502 برمیگردد.

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/nid-image',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    national_code: '0123456789',
    birth_date: 13820214
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "national_code": "0123456789",
    "birth_date": "1382/02/14",
    "images": [
      {
        "type": "Card",
        "image": "data:image",
        "error_code": null
      },
      {
        "type": "Cert",
        "image": null,
        "error_code": "image_not_found"
      }
    ]
  }
}

{
    "message": "خطای سرویس خارجی",
    "data": [],
    "code": "PROVIDER_ERROR",
    "errors": null
}

استعلام هویت اتباع خارجی براساس کدفیدا

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

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

fida_coderequiredstring

کد فیدا

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/fida',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    fida_code: '0123456789'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "fida_code": "0111111111",
    "birth_date": "2001-01-06T00:00:00",
    "first_name": "سیدحمزه",
    "last_name": "وحدت",
    "father_name": "سید ظاهر",
    "grandFatherName": "جان علی",
    "gender": "MALE",
    "province_name": "سمنان",
    "nationality_name": "افغانستان",
    "old_fida_code": "44247278",
    "status": "AUTHORIZED",
    "family_id": "1503119775",
    "exit_from_family": false,
    "identification_code": "150337900745",
    "is_active": true
  }
}

استعلام آدرس براساس کدپستی

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

postal_coderequiredstring

کدپستی ۱۰ رقمی

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/postal-code',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    postal_code: 1894156963
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "avenue": "بن بست هجدهم",
    "floor_no": "همکف",
    "house_no": "12.0",
    "location": "تهران",
    "location_type": "شهر",
    "parish": "شکوفه شمالی ",
    "post_code": "1894156963",
    "pre_avenue": "خیابان شهید غلامحسین زنهاری",
    "side_floor": "",
    "state": "تهران",
    "town_ship": "تهران",
    "village": "",
    "zone": "مرکزی",
    "building_name": "",
    "description": "",
    "location_code": "17373"
  }
}

استعلام اطلاعات شرکت با شناسه ملی

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

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

company_national_idrequiredstring

شناسه ملی شرکت

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/company-information',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    company_national_id: '0123456789'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "national_id": "0123456789",
    "name": "الکترونیک شمال",
    "register_date": "1391/02/30",
    "register_number": "5441441",
    "company_type": "شرکت سهامی خاص",
    "post_code": "1553913917",
    "address": "استان تهران، شهرستان تهران، بخش مرکزی، شهر تهران، خیابان انقلاب",
    "email_address": "",
    "fax_number": "",
    "landline_phone": "",
    "issuance_date": "1391/12/30",
    "create_date_time": "1391/12/30-11:43",
    "activity_end_date": ""
  }
}

استعلام صاحبین امضا شرکت با شناسه ملی

استعلام صاحبین امضا شرکت با شناسه ملی انجام می شود.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

company_national_idrequiredstring

شناسه ملی شرکت

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/company-signature',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    company_national_id: '0123456789'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "obligatory_signature_holders": "دو نفر از اعضای هییت مدیره",
    "newspaper_date": "2024-04-27T00:00:00",
    "newsletter_date": "2024-04-22T00:00:00",
    "company_title": "موسسه فولاد یاس",
    "board_members": [
      {
        "company_id": "0123456789",
        "start_date": "2019-05-20T00:00:00",
        "end_date": "2020-05-20T00:00:00",
        "duration": "1 سال مالی",
        "name": "علی میرسپاسی",
        "tagline": "نایب رییس هییت مدیره در ایده پرداز",
        "position_name": "مدیر عامل و نایب رییس هییت مدیره",
        "position_first_role": "نایب رییس هییت مدیره",
        "position_second_role": null
      },
      {
        "company_id": "1234567890",
        "start_date": "2019-05-20T00:00:00",
        "end_date": "2020-05-20T00:00:00",
        "duration": "1 سال مالی",
        "name": "افشنگ مرادی",
        "tagline": "نایب رییس هییت مدیره در ایده پرداز",
        "position_name": "عضو هییت مدیره",
        "position_first_role": "نایب رییس هییت مدیره",
        "position_second_role": "مدیرعامل"
      }
    ]
  }
}

استعلام و تطبیق کدملی و شبا

استعلام و تطبیق کدملی و شماره شبا بر اساس کدملی، تاریخ تولد و شماره شبا انجام می شود.
در این سرویس انطباق نام مالک شبا با نام مالک کدملی به همراه میزان این انطباق بر حسب درصد انجام می‌شود.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

national_coderequiredstring

کدملی

birth_daterequiredinteger

تاریخ تولد

ibanrequiredstring

شماره شبا

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/national-code-iban',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    national_code: '0111111111',
    birth_date: 13820214,
    iban: 'IR111110000000000011111111'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "percent_compatibility": 4,
    "iban": {
      "iban": "IR111110000000000011111111",
      "account_owners": [
        {
          "lastName": "رضایی",
          "firstName": "علی"
        }
      ]
    },
    "national-code": {
      "alive": true,
      "birth_date": "1376/02/01",
      "nid": "20797680",
      "first_name": "محمد",
      "last_name": "اکبری",
      "father_name": "رضا",
      "gender": null,
      "office_code": null,
      "office_name": null,
      "shenasname_no": null,
      "shenasname_seri": null,
      "shenasname_serial": null,
      "images": null
    }
  }
}

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

این سرویس برای تطبیق شماره کارت با شماره موبایل استفاده می شود. در این سرویس شماره کارت 16 رقمی بانکی به همراه شماره موبایل دریافت می شود. و در خروجی اعلام میکند که ایا شماره موبایل اعلام شده با شماره موبایل ثبت شده برای کارت بانکی یکسان است یا خیر.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار

mobilerequiredstring

شماره موبایل

card_numberrequiredstring

شماره کارت

پاسخ ها

resultinteger

مقدار MATCH نشان دهنده تطبیق شماره موبایل با شماره کارت می باشد. و مقدار NOT_MATCH نشان دهنده عدم تطبق شماره موبایل با شماره کارت می باشد.

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/match-mobile-card',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer token'
  },
  body: JSON.stringify({
    mobile: '09353917307',
    card_number: '6362141801078636'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "result": "MATCH"
  }
}

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

در صورت نیاز می‌توانید از این بخش یک شماره شبا را استعلام نمایید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار است

ibanrequiredstring

شماره شبا

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/iban',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    iban: 'IR040620000000203505282003'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "account_owners": [
      {
        "firstName": "الناز",
        "lastName": "نوروزی"
      }
    ],
    "bank_name": "آینده",
    "account_number": "0301675881008",
    "account_description": "حساب فعال است"
  }
}

استعلام شماره کارت

در صورت نیاز می‌توانید از این بخش یک شماره کارت را استعلام نمایید.

پارامترها

businessrequiredstring

نام انگلیسی کسب و کار است

cardrequiredstring

شماره کارت

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/business/:business/customers/inquiry/card',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    card: '6362141142165890'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "message": "عملیات با موفقیت انجام شد.",
  "data": {
    "account_owner": "الناز نوروزی"
  }
}

روند

با استفاده از سرویس روند، می‌توانید کارت‌های بانکی با طرح و لوگوی اختصاصی کسب‌وکار خود برای کاربران صادر کنید و تمامی عملیات بانکی انتقال وجه (انتقال وجه داخلی، پایا، ساتنا و پل)، دریافت موجودی، پیگیری تراکنش‌ها و مشاهده صورت‌حساب را از طریق API انجام دهید.

آیا این بخش مفید بود؟بلی خیر

تنظیمات کسب و کار

قبل از فراخوانی سرویس‌های روند، لازم است تنظیمات مربوط به کسب‌وکار شما تعریف شود.

آیا این بخش مفید بود؟بلی خیر

POST /v1/business/:business/ravand/set-config

دریافت اطلاعات استاتیک

برای صدور کارت، باید لیستی از اطلاعاتی مانند استان‌ها، شهرها، کد صنف، تحصیلات و مشاغل را دریافت کنید. با ارسال شناسه‌های مربوط به این اطلاعات، می‌توانید جزئیات اطلاعات کاربران خود را به‌روزرسانی کنید.

آیا این بخش مفید بود؟بلی خیر

GET /v1/business/:business/ravand/provinces

GET /v1/business/:business/ravand/cities

GET /v1/business/:business/ravand/guilds

GET /v1/business/:business/ravand/educations

GET /v1/business/:business/ravand/occupations

صدور کارت

برای صدور کارت، این سرویس ها باید فراخوانی شوند: ایجاد کارت، به‌روزرسانی اطلاعات، آپلود مدارک هویتی، دریافت متن ویدیوی احراز هویت، نهایی‌سازی درخواست و پیگیری درخواست. با استفاده از این سرویس‌ها می‌توانید فرآیند صدور کارت را برای کاربران خود به‌طور کامل انجام دهید

آیا این بخش مفید بود؟بلی خیر

POST /v1/business/:business/ravand/provider/:provider/cardholder

PUT /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/video-caption

POST /v1/business/business/ravand/provider/:provider/cardholder/:cardholder_id/upload

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/finalize

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/inquiry

فعالسازی کارت

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

آیا این بخش مفید بود؟بلی خیر

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/card/activate/token

GET /v1/redirect/card/activate/:token

تغییر رمز اول کارت

بعد از فعالسازی کارت، جهت تغییر رمز اول کارت می توانید از این سرویس ها استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/card/change-pin/token

GET /v1/redirect/card/change-pin/:token

مسدود سازی کارت

بعد از فعالسازی کارت، در صورت نیاز به مسدود سازی کارت می توانید از این سرویس ها استفاده کنید.

آیا این بخش مفید بود؟بلی خیر

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/card/block/token

GET /v1/redirect/card/block/:token

عملیات کارت

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

آیا این بخش مفید بود؟بلی خیر

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/card/status?card_number=:card_number

عملیات بانکی

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

آیا این بخش مفید بود؟بلی خیر

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/accounts-info

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/balance

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/bank-statement

GET /v1/business/:business/ravand/reasons

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/retry-otp

POST /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/confirm-otp

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/inquiry

GET /v1/business/:business/ravand/provider/:provider/cardholder/:cardholder_id/transfer/inquiry/paya-satna