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

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

سرویس تسویه

لیست تسویه ها

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

نکته! پارامتر 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

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

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

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"
      },
      {
        "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"
      },
      {
        "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"
      },
      {
        "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"
      },
      {
        "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"
      }
    ],
    "first": "https:\/\/api.settlement.vandar.io\/v1\/settlements?page=1",
    "last": "https:\/\/api.settlement.vandar.io\/v1\/settlements?page=19",
    "prev": null,
    "next": "https:\/\/api.settlement.vandar.io\/v1\/settlements?page=2",
    "current_page": 1,
    "from": 1,
    "last_page": 19,
    "path": "https:\/\/api.settlement.vandar.io\/v1\/settlements",
    "per_page": 5,
    "to": 5,
    "total": 93
  }
}
}

status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
data:
- wallet: مبلغ کیف پول کاربر به تومان
- blocked_amount: مبلغی که به دستور احکام قضایی در حساب مسدود شده است.
- deductible_amount: مبلغ قابل برداشت امروز
- currency:
- settlements:
  - data:
    - id: آیدی تسویه
    - iban_id: شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد
    - gateway_transaction_id: شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار می‌گیرد.
    - amount: مبلغ تسویه به تومان
    - payment_number: شناسه واریز ثبت شده در هنگام ثبت تسویه
    - status: استتوس تسویه
    - wallet: مبلغ کیف پول بعد از انجام این تسویه
    - settlement_date: زمان انجام تسویه
  - first: آدرس اولین صفحه
  - last: آدرس آخرین صفحه
  - prev: آدرس صفحه قبل
  - next: آدرس صفحه بعد
  - current_page: آدرس همین صفحه
  - from: شماره اولین آیتم تسویه ای که در این صفحه آمده است
  - last_page: تعداد کل صفحات تسویه
  - path: آدرس خالص بدون صفحه بندی
  - per_page: تعداد آیتم در هر صفحه
  - to: شماره آخرین آیتم تسویه ای که در این صفحه آمده است
  - total: تعداد کل آیتم های تسویه

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

status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
errors: آرایه ای از خطا‌ها

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

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

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

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

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

name	Type	Status
amount	integer	required
iban	string	required
payment_number	integer	optional
notify_url	string	optional
is_instant	boolean	optional

توضیحات

amount (اجباری): مبلغ تراکنش به تومان و بزرگتر یا مساوی 5000 و کوچکتر یا مساوی مبلغ کیف پول
iban (اجباری): شماره شبا ای که می خواد پول به آن واریز شود
payment_number (اختیاری): شناسه واریز شماره ای اختیاری است تا حداکثر ۱۵ رقم
notify_url (اختیاری): بعد از مشخص شدن وضعیت تسویه این آدرس صدا زده می‌شود.
is_instant (اختیاری): اگر می‌خواهید تسویه در لحظه انجام شود مقدار true و در غیر این صورت مقدار false را ارسال کنید.

نکته! دو پارامتر notify_url و is_instant با هماهنگی فعال خواهند شد.

نمونه json

{
"amount": 50000,
"iban": "IR430550011480005587452001",
"payment_number": "123456",
"notify_url": "https://yourdomain.com/nofiy_me",
"is_instant": false
}

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

HTTP/1.1 200
{
"status": 1,
"data": {
  "settlement": [
    {
      "id": "b6c72d20-a4ba-11ea-8a6c-9dc8b4b708ac",
      "iban_id": "b6b5c440-a4ba-11ea-837b-bf6e427ec6d0",
      "transaction_id": 159100434426,
      "amount": 50000,
      "payment_number": null,
      "status": "PENDING",
      "wallet": 60985,
      "settlement_date": "2020-06-02",
      "settlement_date_jalali": "1399\/03\/13"
    }
  ]
}
}

status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
data:
- wallet: مبلغ کیف پول کاربر به تومان
- blocked_amount: مبلغی که به دستور احکام قضایی در حساب مسدود شده است.
- deductible_amount: مبلغ قابل برداشت امروز
- currency:
- settlements:
  - data:
    - id: آیدی تسویه
    - iban_id: شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد
    - transaction_id: شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار می‌گیرد.
    - amount: مبلغ تسویه به تومان
    - payment_number: شناسه واریز ثبت شده در هنگام ثبت تسویه
    - status: استتوس تسویه
    - wallet: مبلغ کیف پول بعد از انجام این تسویه
    - settlement_date: زمان انجام تسویه
    - settlement_date: زمان انجام تسویه به تاریخ شمسی

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

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

status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
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"
    }
  }
}

status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
data:
- wallet: مبلغ کیف پول کاربر به تومان
- blocked_amount: مبلغی که به دستور احکام قضایی در حساب مسدود شده است.
- deductible_amount: مبلغ قابل برداشت امروز
- currency:
- settlements:
  - data:
    - id: آیدی تسویه
    - iban_id: شناسه یکتای شماره شبا که برای پیگیری شبا در وندار مورد استفاده قرار می گیرد
    - gateway_transaction_id: شناسه یکتای تسویه که برای پیگیری تسویه از وندار مورد استفاده قرار می‌گیرد.
    - amount: مبلغ تسویه به تومان
    - payment_number: شناسه واریز ثبت شده در هنگام ثبت تسویه
    - status: استتوس تسویه
    - wallet: مبلغ کیف پول بعد از انجام این تسویه
    - settlement_date: زمان انجام تسویه

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

status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
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: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
message: درخواست تسویه شما از دستور پرداخت خارج شد و وجه تسویه به حساب شما برگشت داده شد

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

status: مقدار 0 و 1 دارد که نشان دهنده موفقیت آمیز بودن درخواست است
errors: آرایه ای از خطا‌ها

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

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

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