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

صورت حساب

مقدمه

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

کیف پول: نمایش موجودی کیف پول

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

METHOD: GET
URL: https://api.vandar.io/v2/business/{business}/balance
Header: authorization : Bearer {token}

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

HTTP/1.1 200
{
    "status": 1,
    "data": {
        "wallet": 100000,
        "currency": "Toman"
    },
}

توضیحات

  • status: درصورت موفق بودن درخواست این مقدار برابر با 1 می باشد
  • wallet: مقدار کیف پول کسب کار
  • currency: واحد پولی مقدار کیف پول برگشت داده شده مشخص می‌کند
نکته! واحد پول استفاده شده در وب‌سرویس وندار فقط تومان می‌باشد

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

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

توضیحات

  • status: درصورت ناموفق بودن درخواست این مقدار برابر با 0 می باشد
  • error: در صورت منقضی شدن Token ارسالی در Header و یا اشتباه بودن Token با مقدار Unauthenticated برگشت داده می‌شود.

صورت حساب: دریافت لیست تراکنش‌ها و تسویه‌ها

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

METHOD: GET
URL: https://api.vandar.io/v2/business/{business}/transaction?per_page=10&page=1
Header: authorization : Bearer {token}

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

Name Type Status
fromDate String optional
toDate String optional
statusKind String optional
status String optional
channel String optional
formId String optional
ref_id String optional
tracking_code String optional
per_page String optional

توضیحات

  • fromDate (اختیاری): شروع بازه زمانی با فرمت 990504
  • toDate (اختیاری): پایان بازه زمانی با فرمت 990527
  • statusKind (اختیاری): این پارامتر مشخص کننده نوع تراکنش می‌باشد.
    • transactions: مشخص کننده تراکنش‌ها
    • settlements : مشخص کننده تسویه‌ها
  • status (اختیاری): مشخص کننده وضعیت تراکنش یا تسویه می‌باشد
    • succeed: وضعیت موفق
    • failed : وضعیت نا‌موفق
    • pending : وضعیت در حال انجام
    • canceled : وضعیت لغو شده
  • channel (اختیاری): این پارامتر مشخص می‌کند که تراکنش از چه کانالی انجام شده است
    • ipg: تراکنش های درگاه پرداخت
    • form : تراکنش های فرم پرداخت
    • p2p : تراکنش های انتقال وجه داخلی
    • subscription : تراکنش های انتقال وجه داخلی
  • formId (اختیاری): شناسه فرم پرداخت
  • ref_id (اختیاری): این پارامتر جستجو بر اساس کد مرجع را فراهم می‌سازد
  • tracking_code (اختیاری): این پارامتر جستجو بر اساس کد پیگیری را فراهم می‌سازد
  • per_page(اختیاری): تعداد رکورد اطلاعاتی درخواست صورت حساب را مشخص میکند
  • page(اختیاری): با توجه به pagination، صفحه مورد نظر را مشخص می‌کند.

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

HTTP/1.1 200
{
    "status": 1,
    "data": {
        "current_page": 1,
        "data": [
          {
            "id": 158935723830,
            "uuid": "4db0d000-cf14-11ea-a8b4-a7b522e6c1f0",
            "amount": 5000,
            "wage": 0,
            "status": 1,
            "ref_id": "GmshtyjwKStPuEvcEcbWlni0iEEYteNlgq2ZuVucO9",
            "tracking_code": "",
            "card_number": "",
            "cid": "",
            "verified": 0,
            "channel": "پرداخت اینترنتی",
            "payment_date": "11:07:11 - 1399\/5\/3",
            "created_at": "11:06:44 - 1399\/5\/3",
            "wallet": "100000",
            "result": "تراکنش موفق",
            "description": "Lorem ipsom .....",
            "factorNumber": "00120",
            "mobile": "",
            "callback_url": "http:\/\/vandar.ui\/ipg-v3\/verify.php",
            "form_title": "",
            "settlement": "",
            "payer": {
                "ip": "89.196.230.198",
                "name": "",
                "slug": "",
                "avatar": "",
                "email": "",
                "phone": "",
                "address": "",
                "mobile": "",
                "additional_fields": {
                      "name": ""
                      "value": ""
                },
                "description": ""
            },
            "receiver": {
                "name": "",
                "slug": "",
                "avatar": "",
                "iban": "",
                "bank_name": ""
            }
          }
        ],
        "first_page_url": "https:\/\/api.vandar.io\/v2\/{business}\/hosting\/transaction?page=1",
        "from": 1,
        "last_page": 85,
        "last_page_url": "https:\/\/api.vandar.io\/v2\/business\/hosting\/transaction?page=85",
        "next_page_url": "https:\/\/api.vandar.io\/v2\/business\/hosting\/transaction?page=2",
        "path": "https:\/\/api.vandar.io\/v2\/business\/hosting\/transaction",
        "per_page": 10,
        "prev_page_url": "",
        "to": 10,
        "total": 842
    }
}

توضیحات

  • status: درصورت موفق بودن درخواست این مقدار برابر با 1 می باشد
  • current_page: با توجه به برگشت دادن اطلاعات به صورت صفحه به صفحه، صفحه فعلی را نمایش می‌دهد
  • id: شناسه تراکنش یا تسویه را مشخص می‌کند
  • uuid: شناسه یکتای تراکنش یا تسویه را مشخص می‌کند
  • amount: مبلغ کل تراکنش
  • wage: کارمزد تراکنش
  • status: نوع تراکنش را مشخص می‌کند
    • 1: نشان دهنده تراکنش با وضعیت موفق
    • - 1: نشان دهنده تراکنش با وضعیت ناموفق
    • 3 : نشان دهنده تراکنش با وضعیت درحال انجام
    • 2 : نشان دهنده تسویه با وضعیت موفق
    • -2 : نشان دهنده تسویه با وضعیت درحال انجام
    • -3 : نشان دهنده تسویه با وضعیت ناموفق
    • -4 : نشان دهنده تسویه با وضعیت لغو شده
    • 5 : نشان دهنده تراکنش واریزی از نوع انتقال وجه داخلی
    • -5 : نشان دهنده تراکنش خروجی از نوع انتقال وجه داخلی
    • 6 : نشان دهنده تراکنش نوع حق اشتراک
  • ref_id: شناسه مرجع تراکنش یا تسویه
  • tracking_code: کدپیگیری تراکنش
  • verified: در صورت استفاده از درگاه پرداخت دو مرحله‌ای تراکنش تایید شود این مقدار برابر با ۱ می‌باشد در غیر این‌صورت برابر با ۰ می باشد. در درگاه پرداخت تک مرحله‌ای بلافاصله بعد از انجام تراکنش این مقدار ۱ می‌شود
  • channel: توضیحات فارسی نوع تراکنش
  • payment_date: تاریخ و زمان اتمام تراکنش
  • created_at: تاریخ و زمان شروع تراکنش
  • wallet: موجودی کیف پول بعد از تراکنش
  • result: توضیحات تراکنش که از شرکت پرداخت برگشت داده می‌شود
  • description: توضیحات تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
  • factorNumber: شماره فاکتور تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
  • mobile: شماره موبایل تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
  • callback_url: آدرس بازگشتی که بعد از انجام تراکنش به آن صفحه بر‌می‌گردد که که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
  • form_title: در صورت پرداخت از فرم پرداخت عنوان فرم نمایش داده می‌شود
  • settlement:
  • payer: طلاعات پرداخت کننده تراکنش را مشخص‌ می‌کند
    • ip: ip پرداخت کننده در زمان پرداخت را مشخص می‌کند
    • name: نام پرداخت کننده را مشخص می‌کند
    • slug: درصورتی که تراکنش انتقال وحه داخلی باشد شناسه ونداری واریز کننده را نمایش می دهد
    • avatar: درصورتی که تراکنش انتقال وحه داخلی باشد عکس واریز کننده را نمایش می دهد
    • name: نام پرداخت کننده را مشخص می‌کند
    • email: ایمیل پرداخت کننده را مشخص می‌کند
    • phone: شماره تماس پرداخت کننده را مشخص می‌کند
    • address: آدرس پرداخت کننده را مشخص می‌کند
    • mobile: شماره همراه پرداخت کننده را مشخص می‌کند
    • additional_fields: فیلد هایی که به صورت دلخواه به فرم اضافه کرده‌اید در این بخش نمایش داره می‌شود
      • name: نام فیلد دلخواه را نمایش می دهد
      • value: مقدار فیلد دلخواه را نمایش می دهد
    • description: توضیحات پرداخت کننده را مشخص می‌کند
    • نکته: فیلدهای نام، ایمیل، شماره تماس، آدرس، موبایل و توضیحات، زمان پرداخت فرم درصورتی که در تنظیمات فرم فعال شده باشد ذخیره می‌شود
  • receiver: طلاعات دریافت کننده تسویه را مشخص‌ می‌کند
    • name: نام صاحب حساب که تسویه به آن صورت گرفته است
    • slug: درصورتی که تراکنش انتقال وحه داخلی باشد شناسه ونداری دریافت کننده مبلغ را نمایش می دهد
    • avatar: درصورتی که تراکنش انتقال وحه داخلی باشد عکس دریافت کننده مبلغ را نمایش می دهد
    • iban: شماره شبا که تسویه به آن صورت گرفته است
    • bank_name: نام بانک شماره شبا که تسویه به آن صورت گرفته است

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

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

توضیحات

  • status: درصورت ناموفق بودن درخواست این مقدار برابر با 0 می باشد
  • error: در صورت منقضی شدن Token ارسالی در Header و یا اشتباه بودن Token با مقدار Unauthenticated برگشت داده می‌شود.