مستندات وندار | ارایه دهنده راهکارهای پرداخت

آخرین تغییرات: ۱۴۰۰/۱۰/۲۱

مقدمه

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

توضیحات

برای تمامی درخواست های ارسالی باید مقادیر زیر در هدر ارسال شوند: توکن همان کلید API یی است که از وندار دریافت کرده اید.

Accept: application/json
Authorization Bearer {Token}

دریافت لیست حساب های فعال ( Get Active Ibans )

در این بخش، میتوانید لیست حساب های فعال شده خود برای ابزار واریز بانکی را دریافت کنید

Method: GET
Address: https://api.vandar.io/v3/business/{business}/cash-in/account

پارامتر {business} همان نام انگلیسی کسب و کاری است که قصد واریزبانکی به آن را دارید.

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

HTTP/1.1 200
{
   "data": [
    {
      "account_number": "0302956142002",
      "account_description": "حساب فعال است",
      "id": null,
      "IBAN": "IR880620000000302956142002",
      "account_owner": [
        {
          "firstName": "امیر",
          "lastName": "ابوئی  مهریزی"
        }
      ],
      "bank_name": "آینده"
    }
  ]
    },
    {
      "account_number": "0302956142004",
      "account_description": "حساب فعال است",
      "id": null,
      "IBAN": "IR880620000000302956142004",
      "account_owner": [
        {
          "firstName": "امیر",
          "lastName": "ابوئی  مهریزی"
        }
      ],
      "bank_name": "آینده"
    }
  ]
}

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

HTTP/1.1 401
{
  "status": 0,
  "error": "Unauthenticated"
}

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

HTTP/1.1 422
{
  "status": 0,
  "errors": {
    "error": "ابزار واریز بانکی برای شما فعال نیست"
  }
}

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

HTTP/1.1 500
{
  "status": 0,
  "errors": {
    "error": "خطایی رخ داده است. لطفاً مجدداً تلاش کنید"
  }
}

دریافت موجودی حساب ( Get Balance )

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

Method: POST
Address: https://api.vandar.io/v3/business/{business}/cash-in/account/balance

پارامتر {business} همان نام انگلیسی کسب و کاری است که قصد واریزبانکی به آن را دارید.

پارامترهای مجاز

name	Type	Status
iban	string	required

توضیحات

iban (اجباری): شماره شبایی که قصد دریافت موجودی آن را دارید (طبیعتاً باید این شماره شبا جزو شماره شباهایی باید باشد که هنگام فعال سازی ابزار به آن دسترسی دادید و درحال حاضر فعال میباشد)

نمونه json

{
	"iban" : "IR880620000000302956142002",
}

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

HTTP/1.1 200
{
  "balance": 4525586
  "available_balance" : 3200000
}

balance: میزان موجودی کل حساب شما(ریال)
available_balance: میزان موجودی قابل برداشت حساب شما(ریال)

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

HTTP/1.1 401
{
  "status": 0,
  "error": "Unauthenticated"
}

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

HTTP/1.1 422

{
  "message": "The given data was invalid.",
  "errors": {
    "iban": [
      "شماره شبا یافت نشد!"
    ]
  }
}


{
  "message": "The given data was invalid.",
  "errors": {
    "iban": [
      "شماره شبا قابل قبول نیست.",
      "شماره شبا یافت نشد!"
    ]
  }
}



{
  "status": 0,
  "errors": {
    "error": "ابزار واریز بانکی برای شما فعال نیست"
  }
}

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

HTTP/1.1 500
{
  "status": 0,
  "errors": {
    "error": "خطایی رخ داده است. لطفاً مجدداً تلاش کنید"
  }
}

درخواست واریز بانکی ( Deposit )

در این بخش، میتوانید درخواست خود را برای واریز بانکی و شارژ کیف پول خود در وندار ثبت کنید

Method: POST
Address: https://api.vandar.io/v3/business/{business}/cash-in/account/deposit

پارامتر {business} همان نام انگلیسی کسب و کاری است که قصد واریزبانکی به آن را دارید.

پارامترهای مجاز

name	Type	Status
iban	string	required
amount	numeric	required
track_id	string	required
description	string	optional
comment	string	optional

توضیحات

iban (اجباری): شماره شبایی که قصد واریز مبلغ از آن حساب بانکی دارید (طبیعتاً باید این شماره شبا جزو شماره شباهایی باید باشد که هنگام فعال سازی ابزار به آن دسترسی دادید و درحال حاضر فعال میباشد)
amount (اجباری): مبلغ واریز (ریال)
track_id (اجباری): رشته پیگیری که به ازای هر درخواست واریز بایستی یکتا باشد. پیشنهاد ما استفاده از uuid برای این پارامتر است.این پارامتر به حروف بزرگ و کوچک حساس است.
description (اختیاری): توضیحات اختیاری برای ثبت واریز که داخل رسید واریز بانکی قابل مشاهده خواهد بود
comment (اختیاری): توضیحات محرمانه برای ثبت واریز که فقط داخل داشبورد کاربری و فقط برای شما قابل مشاهده خواهد بود

نمونه json

{
	"iban" : "IR880620000000302956142002",
	"amount" : 1500000,
	"track_id" : "2ca25322-d10a-49fb-a000-788e1f59ff33",
	"description" : "تراکنش واریز بانکی تست",
}

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

HTTP/1.1 200
{
  "status": 1,
  "message": "تراکنش های واریزبانکی با موفقیت ثبت شد",
  "data": {
    "cash_in": [
      {
        "gateway_transaction_id": 161113594985,
        "amount": 1500000,
        "amount_toman": 150000,
        "wage": 0,
        "wage_toman": 0,
        "status": "INIT",
        "iban": "IR880620000000302956142002",
        "receipt_url": "https://vand.ar/qml22"
      },
    ]
  }

status (منسوخ شده): ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
message: پیغام تراکنش های واریزبانکی با موفقیت ثبت شد
data:
- cash_in:
  - gateway_transaction_id: شناسه یکتای واریز وجه
  - amount: مبلغ واریز وجه
  - amount_toman: مبلغ واریز وجه (تومان)
  - wage: کارمزد
  - wage_toman: کارمزد (تومان)
  - status: وضعیت واریز وجه که INIT به معنای قرارگرفتن در صف واریز میباشد
  - iban: شماره شبا ارسال شده برای انجام واریز بانکی
  - receipt_url: لینک رسید واریز بانکی

نکته! در صورتی که مبلغ واریز بانکی شما بالای 100میلیون تومان میباشد، در response درخواست، لیست تراکنش های شما به ازای هر 100میلیون به شما نمایش داده خواهد شد

نمونه json

{
	"iban" : "IR880620000000302956142002",
	"amount" : 1200000000,
	"track_id" : "2ca25322-d10a-49fb-a000-788e1f59ff33",
	"description" : "تراکنش واریز بانکی تست",
}

نمونه پاسخ دریافتی موفق (مبلغ بالای 100میلیون تومان):

HTTP/1.1 200
{
  "status": 1,
  "message": "تراکنش های واریزبانکی با موفقیت ثبت شد",
  "data": {
    "cash_in": [
      {
        "gateway_transaction_id": 161113594985,
        "amount": 1000000000,
        "amount_toman": 100000000,
        "wage": 0,
        "wage_toman": 0,
        "status": "INIT",
        "iban": "IR880620000000302956142002",
        "receipt_url": "https://vand.ar/qml22"
      },
       {
        "gateway_transaction_id": 161113594986,
        "amount": 200000000,
        "amount_toman": 20000000,
        "wage": 0,
        "wage_toman": 0,
        "status": "INIT",
        "iban": "IR880620000000302956142002",
        "receipt_url": "https://vand.ar/qml22"
      }
    ]
  }

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

HTTP/1.1 401
{
  "status": 0,
  "error": "Unauthenticated"
}

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

HTTP/1.1 422

{
  "message": "The given data was invalid.",
  "errors": {
    "iban": [
      "شماره شبا یافت نشد!"
    ]
  }
}


{
  "message": "The given data was invalid.",
  "errors": {
    "track_id": [
      "این شماره پیگیری از قبل ثبت شده است."
    ]
  }
}



{
  "status": 0,
  "errors": {
    "error": "ابزار واریز بانکی برای شما فعال نیست"
  }
}

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

HTTP/1.1 500
{
  "status": 0,
  "errors": {
    "error": "خطایی رخ داده است. در صورت اطمینان از عدم برداشت مجدد تلاش کنید."
  }
}