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

آخرین تغییرات: ۱۳۹۹/۱۱/۱۰

سرویس تسویه

لیست تسویه ها

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

نکته! پارامتر deductible_amount نشان‌دهنده مبلغ قابل برداشت امروز و پارامتر blocked_amount نشان‌دهنده مبلغ مسدود‌شده در حساب است.

نکته! انواع حالت‌های ممکن تسویه (فیلد status مربوط به settlement) عبارتند از: INIT, PENDING, DONE, FAILED, CANCELED

- INIT: وقتی که تسویه به بانک فرستاده می‌شود.
- PENDING: وقتی که تسویه به بانک فرستاده شده و در انتظار رسیدن به سیکل مورد نظر است.
- DONE: تسویه‌ای که با موفقیت انجام شده است.
- FAILED: تسویه‌ای که با خطا مواجه شده است.
- CANCELED: تسویه لغو شده است. لازم به ذکر است که امکان لغو تسویه در وضعیت تسویه‌ی آنی وجود ندارد.

METHOD: GET
URL: https://api.vandar.io/v2.1/business/{business}/settlement?per_page=10&page=1

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

per_page(اختیاری): تعداد رکورد اطلاعاتی درخواست تسویه را مشخص میکند

page(اختیاری): صفحه مورد نظر را مشخص می‌کند.

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

HTTP/1.1 200
{
"status": 1,
"data": {
  "wallet": 26099,
  "blocked_amount": 0,
  "deductible_amount": 26099,
  "currency": "Toman",
  "settlements": {
    "data": [
      {
        "id": "8edaa0a0-a33f-11ea-838d-676dce32760e",
        "iban_id": 22822, 
        "gateway_transaction_id": 159024236678,
        "amount": 100000,
        "payment_number": null,
        "status": "CANCELED",
        "wallet": 160985,
        "settlement_date": "2020-05-31",
        "description": "توضیحات"
      },
      {
        "id": "807003f0-8398-11ea-a42b-ede62b9de0c1",
        "iban_id": 902,
        "gateway_transaction_id": 158745010355,
        "amount": 50000,
        "payment_number": null,
        "status": "DONE",
        "wallet": 99485,
        "settlement_date": "2020-04-21",
        "description": "توضیحات"

      },
      {
        "id": "010a7850-82ff-11ea-85bd-49ef214903e3",
        "iban_id": 902,
        "gateway_transaction_id": 158738422601,
        "amount": 68000000,
        "payment_number": null,
        "status": "DONE",
        "wallet": 126485,
        "settlement_date": "2020-04-21",
        "description": "توضیحات"

      },
      {
        "id": "53665740-82cf-11ea-baf3-95ebee6a9eca",
        "iban_id": 26,
        "gateway_transaction_id": 158736374134,
        "amount": 15000000,
        "payment_number": null,
        "status": "CANCELED",
        "wallet": 43126485,
        "settlement_date": "2020-04-21",
        "description": "توضیحات"

      },
      {
        "id": "456afdb0-82cf-11ea-8e13-3183b5b1630b",
        "iban_id": 7215,
        "gateway_transaction_id": 158736367341,
        "amount": 5000000,
        "payment_number": null,
        "status": "CANCELED",
        "wallet": 58126485,
        "settlement_date": "2020-04-21",
        "description": "توضیحات"

      }
    ],
    "first": "https:\/\/api.vandar.io\/v2.1\/business\/{business}\/settlement?page=1",
    "last": "https:\/\/api.vandar.io\/v2.1\/business\/{business}\/settlement?page=19",
    "prev": null,
    "next": "https:\/\/api.vandar.io\/v2.1\/business\/{business}\/settlement?page=2",
    "current_page": 1,
    "from": 1,
    "last_page": 19,
    "path": "https:\/\/api.vandar.io\/v2.1\/business\/{business}\/settlement",
    "per_page": 5,
    "to": 5,
    "total": 93
  }
}
}

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
data:
- wallet: مبلغ کیف پول کاربر به تومان
- blocked_amount: مبلغی که به دستور احکام قضایی در حساب مسدود شده است.
- deductible_amount: مبلغ قابل برداشت امروز
- currency:
- settlements:
  - data:
    - id: شناسه تسویه
    - iban_id: شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد
    - gateway_transaction_id: شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار می‌گیرد.
    - amount: مبلغ تسویه به تومان
    - payment_number: شناسه واریز ثبت شده در هنگام ثبت تسویه
    - status: وضعیت تسویه
    - wallet: مبلغ کیف پول بعد از انجام این تسویه
    - settlement_date: (میلادی) تاریخ انجام تسویه
    - description: توضیحاتی که در هنگام ثبت تسویه ارسال شده است.
  - first: آدرس اولین صفحه
  - last: آدرس آخرین صفحه
  - prev: آدرس صفحه قبل
  - next: آدرس صفحه بعد
  - current_page: آدرس همین صفحه
  - from: شماره اولین آیتم تسویه ای که در این صفحه آمده است
  - last_page: تعداد کل صفحات تسویه
  - path: آدرس خالص بدون صفحه بندی
  - per_page: تعداد آیتم در هر صفحه
  - to: شماره آخرین آیتم تسویه ای که در این صفحه آمده است
  - total: تعداد کل آیتم های تسویه

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

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
errors: آرایه ای از خطا‌ها

ثبت درخواست تسویه

در این بخش شما می‌توانید یک درخواست تسویه را ثبت نمایید.

METHOD: POST
URL: https://api.vandar.io/v3/business/{business}/settlement/store

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

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

name	Type	Status
amount	integer	required
iban	string	required
track_id	string	required
payment_number	integer	optional
notify_url	string	optional
description	string	optional

توضیحات

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

نمونه json

{
"amount": 5000,
"iban": "IR430550011480005587452001",
"track_id": "6feb8114-25d5-372e-83e0-23ae783041a9",
"payment_number": "123456",
}

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

HTTP/1.1 200
{
   "status":1,
   "data":{
      "settlement":[
         {
            "id":"406f20d0-397a-11ec-b752-6b667e3fe6ba",
            "iban_id":"083510a0-f998-11eb-8c11-27d425426e06",
            "transaction_id":163559577615,
            "amount":50000,
            "amount_toman":5000,
            "wage_toman":0,
            "payment_number":null,
            "status":"PENDING",
            "wallet":"221500",
            "description":"تسویه حساب وندار",
            "settlement_date":"2021-10-30",
            "settlement_time":"15:39:36",
            "settlement_date_jalali":"1400\/08\/08",
            "settlement_done_time_prediction":"1400\/08\/08 16:00:00",
            "is_instant":false,
            "prediction":{
               "date":"1400\/8\/8",
               "time":"16:00:00",
               "extra":"امروز"
            },
            "receipt_url": "https:\/\/vand.ar\/Mcz6C"
         }
      ]
   }
}

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
data:
- id: شناسه یکتای تسویه
- iban_id: شناسه یکتای شماره شبا
- transaction_id:شناسه یکتای تراکنش در وندار
- amount: مبلغ تسویه به ریال
- amount_toman: مبلغ تسویه به تومان
- wage_toman:کارمزد مبلغ تسویه به تومان
- payment_number: شناسه پرداخت
- status: وضعیت تسویه
- wallet: مبلغ باقی مانده کیف پول بعد از تسویه
- settlement_date: تاریخ انجام تسویه
- settlement_time: زمان انجام تسویه
- settlement_date_jalali: تاریخ شمسی انجام تسویه
- settlement_done_time_prediction: زمان تخمینی واریز به حساب مقصد
- prediction: تحمین زمان واریز
- description: توضیحات
- receipt_url: لینک رسید تسویه. در این لینک جزییات ثبت تسویه از جمله زمان ثبت تسویه، واریز کننده، دریافت کننده، زمان تخمینی واریز کد رهگیری و مبلغ و ... قابل مشاهده است.

نکته!
در صورتی که مقدار پارامتر notify_url تکمیل شود، پس از انجام تراکنش تسویه، وبهوکی با فرمت زیر به آدرس ثبت شده ارسال خواهد شد

HTTP/1.1 200
{
    "id": "865e9d07-2c96-41ef-8f61-30de27fb9954"
    "iban_id": "72a8aab1-04c9-417e-9971-2f7bfe121b53"
    "transaction_id": "164258101221"
    "amount": "2500000"
    "payment_number": "123456"
    "status": "DONE"
    "settlement_date": "2022-01-19"
    "settlement_date_jalali": "1400/10/29"
    "revised_transaction_id": ""
    "ref_code": "140010290622047785"
}

id: شناسه یکتای تسویه
iban_id: شناسه یکتای شماره شبا
transaction_id:شناسه یکتای تراکنش در وندار
amount: مبلغ تسویه به ریال
payment_number: شناسه پرداخت
status: وضعیت تسویه
settlement_date: تاریخ انجام تسویه (میلادی)
settlement_date_jalali:تاریخ انجام تسویه (شمسی)
revised_transaction_id: شناسه یکتای تراکنش اصلاحی برای تسویه های کنسل شده
ref_code: (یا همان کد RRN) شناسه یکتای مرجع تسویه انجام شده برای تسویه های موفق

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

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

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
errors: آرایه ای از خطا‌ها

نمایش جزییات یک تسویه

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

METHOD: GET
URL: https://api.vandar.io/v2.1/business/{business}/settlement/{id}

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

پارامتر {id} همان id مربوط به تسویه‌ای است که قصد نمایش آن را دارید.

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

HTTP/1.1 200
{
  "status": 1,
  "data": {
    "settlement": {
      "id": "8edaa0a0-a33f-11ea-838d-676dce32760e",
      "iban_id": 22822,
      "gateway_transaction_id": 159024236678,
      "amount": 100000,
      "payment_number": null,
      "status": "CANCELED",
      "wallet": 160985,
      "settlement_date": "2020-05-31",
      "description": "توضیحات",
    }
  }
}

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
data:
- wallet: مبلغ کیف پول کاربر به تومان
- blocked_amount: مبلغی که به دستور احکام قضایی در حساب مسدود شده است.
- deductible_amount: مبلغ قابل برداشت امروز
- currency:
- settlements:
  - data:
    - id: شناسه تسویه
    - iban_id: شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد
    - gateway_transaction_id: شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار می‌گیرد.
    - amount: مبلغ تسویه به تومان
    - payment_number: شناسه واریز ثبت شده در هنگام ثبت تسویه
    - status: وضعیت تسویه
    - wallet: مبلغ کیف پول بعد از انجام این تسویه
    - settlement_date: تاریخ انجام تسویه (میلادی)
    - description: توضیحاتی که در هنگام ثبت تسویه ارسال شده است.

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

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
errors: آرایه ای از خطا‌ها

لغو یک تسویه

در این بخش شما می‌توانید یک درخواست تسویه در حال انجام یا ناموفق را لغو نمایید.

METHOD: DELETE
URL: https://api.vandar.io/v2.1/business{business}/settlement/{transaction_id}

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

پارامتر {transaction_id} همان transaction_id مربوط به تسویه‌ای است که قصد لغو آن را دارید.

HTTP/1.1 200
{
"status": 1,
"message": "درخواست تسویه شما از دستور پرداخت خارج شد و وجه تسویه به حساب شما برگشت داده شد"
}

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
message: درخواست تسویه شما از دستور پرداخت خارج شد و وجه تسویه به حساب شما برگشت داده شد

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

status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره. اما افزون بر این، فیلد status برای کمک به شماست که متوجه شوید آیا این api کاری که به آن محول شده را به درستی انجام داده است یا خیر. به طور خلاصه:
1 به معنای این است که http response از خانواده‌ی ۲۰۰ است.
0 به معنای این است که http response از خانواده‌ی ۴۰۰ یا ۵۰۰ است.
errors: آرایه ای از خطا‌ها

وضعیت سلامت بانک‌های سرویس تسویه

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

METHOD: GET
URL: https://health.vandar.io/settlement