Vandar

مقدمه

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

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

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

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/v3/business/{business}/transaction
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
id	String	optional
track_id	String	optional
factor_number	String	optional
per_page	String	optional
start_after	String	optional
q	String	optional
search_field	String	optional

توضیحات

• fromDate (اختیاری): شروع بازه زمانی با فرمت 14000102
• toDate (اختیاری): پایان بازه زمانی با فرمت 14000201
• statusKind (اختیاری): این پارامتر مشخص کننده نوع تراکنش می‌باشد.
• transactions: مشخص کننده تراکنش‌ها
• settlements : مشخص کننده تسویه‌ها
• status (اختیاری): مشخص کننده وضعیت تراکنش یا تسویه می‌باشد
• succeed: وضعیت موفق
• failed : وضعیت نا‌موفق
• pending : وضعیت در حال انجام
• canceled : وضعیت لغو شده
• channel (اختیاری): این پارامتر مشخص می‌کند که تراکنش از چه کانالی انجام شده است
• ipg: تراکنش های درگاه پرداخت
• form : تراکنش های فرم پرداخت
• p2p : تراکنش های انتقال وجه داخلی
• subscription : تراکنش های سرویس پرداخت خودکار
• settlements : تراکنش های تسویه و تسهیم
• cash-in : تراکنش های واریز بانکی
• cash-in-by-code : تراکنش های واریز بانکی با شناسه واریز
• formId (اختیاری): شناسه فرم پرداخت
• ref_id (اختیاری): این پارامتر جستجو بر اساس کد مرجع را فراهم می‌سازد
• tracking_code (اختیاری): این پارامتر جستجو بر اساس کد پیگیری را فراهم می‌سازد
• id(اختیاری): شناسه یکتای تراکنش
• track_id(اختیاری): کد رهگیری در زمان ثبت تسویه
• factor_number(اختیاری): شماره فاکتور که در زمان ایجاد تراکنش درگاه پرداخت ارسال می شود
• per_page(اختیاری): تعداد رکورد اطلاعاتی درخواست صورت حساب را مشخص میکند (حداکثر مقدار مجاز 100 می‌باشد)
• start_after(اختیاری): این پارامتر مشخص میکند که تراکنش های بعد از این تراکنش در لیست خروجی بازگردانده شوند. برای دریافت صفحه های بعدی میتوانید ایدی اخرین تراکنش را در این پارامتر ارسال کنید. تا لیست جدید را دریافت کنید.
• q(اختیاری): مقدار موجود در این پارامتر در فیلدهای تراکنش و فرم و ... جستجو می شود
• search_field (اختیاری): محدوده ی جستجو
• description: اطلاعات تراکنش
• ref_id : کد مرجع
• tracking_code : کد پیگیری
• transaction_id : شناسه یکتای تراکنش
• factor_number : شماره فاکتور
• iban : شماره شبا
• mobile_number : شماره موبایل
• api_token : توکن
• card_number : شماره کارت
• form_id : شناسه فرم
• payment_number : شناسه واریز

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

HTTP/1.1 200
{
    "status": 1,
    "has_more": true,
    "data": {
            "id":  165374316188,
            "uuid":  "73b82710-de88-11ec-ae19-47c5d7c58ae4",
            "amount":  1650000,
            "wage":  0,
            "status":  -1,
            "ref_id":  null,
            "tracking_code":  null,
            "card_number":  null,
            "cid":  null,
            "verified":  0,
            "channel":  "پرداخت اینترنتی",
            "payment_date":  null,
            "payment_number":  null,
            "created_at":  "17:46:57 - 1401/3/7",
            "updated_at":  "17:46:58 - 1401/3/7",
            "wallet":  0,
            "result":  null,
            "description "خرید به شماره سفارش : 91 | محصولات - تست (165)" ,
            "factorNumber":  null,
            "mobile":  null,
            "callback_url": "http://wordpress.local/?wc-api=WC_Vandar&wc_order=91",
            "form_title": null,
            "settlement": null,
            "settlement_port": null,
            "comments": [],
            "api_token": "QRI4AZLY17SCG",
            "logs": {
                "transaction_id": 165374316188,
                "result_code": "-2",
                "result_message": "کاربر صفحه پرداخت را ترک کرده است.",
                "log_date": "1401-03-07 18:20:48",
                "group": "خطای کاربر"
             },
            "revised_transaction_id":  null,
            "refund":  null,
            "refund_detail_ids":  [],
	    "port":  "SAMAN",
            "payer": {
                 "ip": "167.235.19.231",
                 "iban": null,
                 "name": null,
                 "slug": null,
                 "avatar": null,
                 "legal_name": null,
                 "business_owner": null,
                 "email": null,
                 "phone": null,
                 "address": null,
                 "mobile": null,
                 "additional_fields": null,
                 "description":  "خرید به شماره سفارش : 91 | محصولات - تست (165)",
             },
            "receiver": {
                  "name": null,
                  "legal_name": null,
                  "slug": null,
                  "avatar": null,
                  "business_owner": null,
                  "iban": null,
                  "bank_name": null
             },
            "receipt_url": null,
            "time_prediction": {
                  "settlement_done_time_prediction": null
                  "settlement_cancelable_time": null
                  "is_settlement_paya_report_finally": null
                  "settlement_paya_report_finally_time": null
                  "is_after_time_prediction": null
                  "p2p_time_prediction": null
                                },
    }
}
                            

توضیحات

• status: درصورت موفق بودن درخواست این مقدار برابر با 1 می باشد
• has_more: در صورتی عناصر بیشتری از مجموعه وجود دارد این مقدار برابر با true می باشد. در غیر اینصورت مقدار false برگشت داده می شود. در صورت true بودن میتوانید از پارامتر ورودی start_after در ورودی استفاده کنید
• id: شناسه تراکنش یا تسویه را مشخص می‌کند
• uuid: شناسه یکتای تراکنش یا تسویه را مشخص می‌کند
• amount: مبلغ کل تراکنش به تومان
• wage: کارمزد تراکنش به تومان
• status: نوع تراکنش را مشخص می‌کند
• 1: نشان دهنده تراکنش با وضعیت موفق
• - 1: نشان دهنده تراکنش با وضعیت ناموفق
• 3 : نشان دهنده تراکنش با وضعیت درحال انجام
• 2 : نشان دهنده تسویه با وضعیت موفق
• -2 : نشان دهنده تسویه با وضعیت درحال انجام
• -3 : نشان دهنده تسویه با وضعیت ناموفق
• -4 : نشان دهنده تسویه با وضعیت لغو شده
• 5 : نشان دهنده تراکنش واریزی از نوع انتقال وجه داخلی
• -5 : نشان دهنده تراکنش خروجی از نوع انتقال وجه داخلی
• 6 : نشان دهنده تراکنش نوع حق اشتراک
• -6 : نشان دهنده تسویه ای است که از سمت وندار یا بانک برگشت داده شده است
• 4 : نشان دهنده تراکنش اصلاح شده می باشد
• ref_id: شناسه مرجع تراکنش یا تسویه
• tracking_code: کدپیگیری تراکنش
• verified: در صورت استفاده از درگاه پرداخت دو مرحله‌ای تراکنش تایید شود این مقدار برابر با ۱ می‌باشد در غیر این‌صورت برابر با ۰ می باشد. در درگاه پرداخت تک مرحله‌ای بلافاصله بعد از انجام تراکنش این مقدار ۱ می‌شود
• channel: توضیحات فارسی نوع تراکنش
• payment_date: تاریخ و زمان اتمام تراکنش
• effective_time_stamp: مقدار timestamp تاریخ و زمان اتمام تراکنش
• receipt_url: لینک رسید برای تسویه های موفق
• created_at: تاریخ و زمان شروع تراکنش
• wallet: موجودی کیف پول بعد از تراکنش
• result: توضیحات تراکنش که از شرکت پرداخت برگشت داده می‌شود
• description: توضیحات تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
• factorNumber: شماره فاکتور تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
• mobile: شماره موبایل تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
• callback_url: آدرس بازگشتی که بعد از انجام تراکنش به آن صفحه بر‌می‌گردد که که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است
• form_title: در صورت پرداخت از فرم پرداخت عنوان فرم نمایش داده می‌شود
• settlement:
• port: پورت انجام تراکنش که در حال حاضر می تواند SAMAN و یا BEHPARDAKHT باشد
• 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 برگشت داده می‌شود.

جزئیات صورت حساب: دریافت جزئیات صفحه بندی

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

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

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

Name	Type	Status
per_page	String	optional
page	String	optional

توضیحات

• per_page(اختیاری): تعداد رکورد اطلاعاتی درخواست صورت حساب را مشخص میکند
• page(اختیاری): با توجه به pagination، صفحه مورد نظر را مشخص می‌کند.

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

HTTP/1.1 200
{
    "status": 1,
    "data": {
        "total":  846,
        "pages":  43,
    },
  } 

توضیحات

• total: تعداد کل گزارشات
• pages: تعداد کل صفحات صورتحساب