آخرین تغییرات: 1401/09/29

مقدمه

سرویس مشتریان چیست:

سرویس مشتریان جهت مدیریت طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط این سرویس، پذیرندگان می‌توانند اطلاعات هویتی، کیف پول، شبا، کارت، اشتراک‌ها و تراکنش‌های مشتریان خود را مدیریت کنند.

توضیحات

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

Accept: application/json
Authorization Bearer {Token}

مشتریان

در این بخش سرویس‌های ثبت مشتری، فیلدهای اختصاصی مشتری، مشاهده لیست مشتریان، ویرایش اطلاعات مشتری، حذف مشتری و مشاهده اطلاعات یک مشتری ارائه می‌شوند.

۱. لیست مشتریان:

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

Method: GET
Address: https://api.vandar.io/v2/business/{business}/customers

پارامتر {business} نام انگلیسی کسب و کار است.

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

HTTP/1.1 200
{
    "data": [
        {
            "id": "394dd280-210f-11ec-96d5-95b80dce5a5a",
            "name": "تست",
            "balance": 0,
            "created_at": "13:53 - 1400/07/07",
            "mobile": null,
            "custom_fields": [
                {
                    "key": "سن",
                    "value": "25"
                },
                {
                    "key": "تاریخ تولد",
                    "value": "1376/01/01"
                }
            ]
        },
        {
            "id": "35e431e0-210c-11ec-9200-79b42496d8e0",
            "name": "الناز نوروزی",
            "balance": 0,
            "created_at": "13:31 - 1400/07/07",
            "mobile": "09121234567",
            "custom_fields": [
                {
                    "key": "سن",
                    "value": "25"
                },
                {
                    "key": "تاریخ تولد",
                    "value": "1376/01/01"
                }
             ]
        }
    ],
    "links": {
        "first": "https://customer.vandar.io/v2/business/{business}/customers?page=1",
        "last": "https://customer.vandar.io/v2/business/{business}/customers?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://customer.vandar.io/v2/business/{business}/customers",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}
  • status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره.
  • data:
    • id: شناسه یکتای مشتری
    • name: نام مشتری که برای مشتری حقیقی نام و نام خانوادگی مشتری و برای مشتری حقوقی نام نماینده می‌باشد.
    • balance: موجودی کیف پول مشتری
    • created_at: تاریخ ثبت مشتری
    • mobile: شماره موبایل مشتری
    • custom_fields: لیست فیلد های اختصاصی ثبت شده
  • links:
    • first: آدرس اولین صفحه
    • last: آدرس آخرین صفحه
    • prev: آدرس صفحه قبل
    • next: آدرس صفحه بعد
  • meta:
    • current_page: آدرس همین صفحه
    • from: شماره اولین آیتمی که در این صفحه آمده است
    • last_page: تعداد کل صفحات
    • path: آدرس خالص بدون صفحه بندی
    • per_page: تعداد آیتم در هر صفحه
    • to: شماره آخرین آیتمی که در این صفحه آمده است
    • total: تعداد کل آیتم ها

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

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

۲. ثبت مشتری جدید

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

METHOD: POST
URL: https://api.vandar.io/v2/business/{business}/customers

پارامتر {business} نام انگلیسی کسب و کار است.

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

name Type Status
first_name string optional
last_name string optional
legal_name string optional
agent_name string optional
type string required in:INDIVIDUAL,LEGAL
mobile string required if type=INDIVIDUAL
agent_mobile string required if type=LEGAL
telephone string optional
individual_national_code string required if type=INDIVIDUAL
legal_national_code string required if type=LEGAL
province_id string optional
city_id string optional
address string optional
postal_code string optional
mcc_code string optional
custom_fields array optional

توضیحات

  • first_name (اختیاری): نام مشتری در صورتی که نوع مشتری حقیقی باشد.
  • last_name (اختیاری): نام خانوادگی مشتری در صورتی که نوع مشتری حقیقی باشد.
  • legal_name (اختیاری): نام حقوقی در صورتیکه مشتری حقوقی باشد.
  • agent_name (اختیاری): نام نماینده شرکت در صورتی که مشتری حقوقی باشد.
  • type (اجباری): نوع مشتری که شامل حقیقی (INDIVIDUAL) و حقوقی (LEGAL) می‌باشد.
  • mobile (اجباری برای مشتری حقیقی): شماره موبایل مشتری در صورتی که نوع مشتری حقیقی باشد.
  • agent_mobile (اجباری برای مشتری حقوقی): شماره موبایل مشتری در صورتی که نوع مشتری حقوقی باشد.
  • telephone (اختیاری): شماره تلفن ثابت.
  • individual_national_code (اجباری برای مشتری حقیقی): کد ملی مشتری در صورتی که نوع مشتری حقوقی باشد.
  • legal_national_code (اجباری برای مشتری حقوقی): کد ملی مشتری در صورتی که نوع مشتری حقوقی باشد.
  • province_id (اختیاری): آیدی استان محل سکونت مشتری.
  • city_id (اختیاری): آیدی شهر محل سکونت مشتری.
  • address (اختیاری): آدرس محل سکونت مشتری.
  • postal_code (اختیاری): کدپستی محل سکونت مشتری.
  • mcc_code (اختیاری برای مشتری حقوقی): کد صنف مشتری.
  • custom_fields (اختیاری): فیلد های اختصاصی مشتری. قبل از ثبت این فیلد باید فیلد های اختصاصی برای کسب و کار از طریق سرویس مربوطه که در ادامه توضیح داده خواهد شد ثبت شود.

نکته

  • برای دریافت آیدی استان و شهر از سرویس زیر استفاده نمایید:

    https://api.vandar.io/v2/information/cities

  • برای دریافت آیدی اصناف از سرویس زیر استفاده نمایید:

    https://api.vandar.io/v2/information/mccs

نمونه json برای ثبت نام مشتری حقیقی 

{
    "first_name": "الناز",
    "last_name": "نوروزی",
    "type": "INDIVIDUAL",
    "mobile": "09121234567",
    "telephone": "",
    "individual_national_code": "1234567890",
    "province_id": "8",
    "city_id": "6",
    "address": "تهران...",
    "postal_code": "",
    "custom_fields": [
        {"field_id": 1, "field_value": "25"},
        {"field_id": 2, "field_value": "01/01/1376"},
    ]
}

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

HTTP/1.1 200
{
    "status": "1",
    "message": "مخاطب با موفقیت ثبت گردید.",
    "result": {
        "customer": {
            "id": "35e431e0-210c-11ec-9200-79b42496d8e0"
        }
    }
}

نمونه json برای ثبت نام مشتری حقوقی 

{
    "legal_name": "تست",
    "agent_name": "نوروزی",
    "type": "LEGAL",
    "agent_mobile": "09121234567",
    "telephone": "",
    "legal_national_code": "1234567890",
    "province_id": "8",
    "city_id": "6",
    "address": "تهران",
    "postal_code": ""
    "mcc_code": "",
    "custom_fields": [
        {"field_id": 1, "field_value": "25"},
        {"field_id": 2, "field_value": "01/01/1376"},
    ]
}

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

HTTP/1.1 200
{
    "status": "1",
    "message": "مخاطب با موفقیت ثبت گردید.",
    "result": {
        "customer": {
            "id": "394dd280-210f-11ec-96d5-95b80dce5a5a"
        }
    }
}

در صورتی که از قبل فیلد اختصاصی برای کسب و کار ثبت نشده باشد خطای زیر برگردانده می شود: 

HTTP/1.1 422
{
    "message": "چنین فیلدی برای این کسب و کار ثبت نشده است.",
    "errors": {
        "custom_fields.0.field_id": [
            "چنین فیلدی برای این کسب و کار ثبت نشده است."
        ]
    }
}

۳. ویرایش اطلاعات مشتری

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

 METHOD: PUT
 URL: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

name Type Status
first_name string optional
last_name string optional
legal_name string optional
agent_name string optional
type string required in:INDIVIDUAL,LEGAL
mobile string optional
agent_mobile string optional
telephone string optional
individual_national_code string optional
legal_national_code string optional
province_id string required if city_id is set
city_id string required if province_id is set
address string optional
postal_code string optional
mcc_code string optional
custom_fields array optional

توضیحات

  • first_name (اختیاری): نام مشتری در صورتی که نوع مشتری حقیقی باشد.
  • last_name (اختیاری): نام خانوادگی مشتری در صورتی که نوع مشتری حقیقی باشد.
  • legal_name (اختیاری): نام حقوقی در صورتیکه مشتری حقوقی باشد.
  • agent_name (اختیاری): نام نماینده شرکت در صورتی که مشتری حقوقی باشد.
  • type (اجباری): نوع مشتری که شامل حقیقی (INDIVIDUAL) و حقوقی (LEGAL) می‌باشد.
  • mobile (اختیاری برای مشتری حقیقی): شماره موبایل مشتری در صورتی که نوع مشتری حقیقی باشد.
  • agent_mobile (اختیاری برای مشتری حقوقی): شماره موبایل مشتری در صورتی که نوع مشتری حقوقی باشد.
  • telephone (اختیاری): شماره تلفن ثابت.
  • individual_national_code (اختیاری برای مشتری حقیقی): کد ملی مشتری در صورتی که نوع مشتری حقوقی باشد.
  • legal_national_code (اختیاری برای مشتری حقوقی): کد ملی مشتری در صورتی که نوع مشتری حقوقی باشد.
  • province_id (اختیاری): آیدی استان محل سکونت مشتری.
  • city_id (اختیاری): آیدی شهر محل سکونت مشتری.
  • address (اختیاری): آدرس محل سکونت مشتری.
  • postal_code (اختیاری): کدپستی محل سکونت مشتری.
  • mcc_code (اختیاری): کدپستی محل سکونت مشتری.
  • custom_fields (اختیاری): فیلد های اختصاصی مشتری. قبل از ثبت این فیلد باید فیلد های اختصاصی برای کسب و کار از طریق سرویس مربوطه که در ادامه توضیح داده خواهد شد ثبت شود.

نکته

  • برای دریافت آیدی استان و شهر از سرویس زیر استفاده نمایید:

    https://api.vandar.io/v2/information/cities

  • برای دریافت آیدی اصناف از سرویس زیر استفاده نمایید:

    https://api.vandar.io/v2/information/mccs

نمونه json برای ثبت نام مشتری حقیقی 

 {
     "first_name": "الناز",
     "last_name": "نوروزی",
     "type": "INDIVIDUAL",
     "mobile": "09121234567",
     "telephone": "",
     "individual_national_code": "1234567890",
     "province_id": "8",
     "city_id": "6",
     "address": "تهران...",
     "postal_code": "1234567890",
     "custom_fields": [
        {"field_id": 1, "field_value": "25"},
        {"field_id": 2, "field_value": "01/01/1376"},
     ]
 }

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

 HTTP/1.1 200
 {
  "message": "مخاطب با موفقیت به‌روزرسانی شد.",
  "customer": {
      "name": "الناز نوروزی",
      "first_name": "الناز",
      "last_name": "نوروزی",
      "legal_name": null,
      "agent_name": null,
      "type": "INDIVIDUAL",
      "mobile": "09121234567",
      "agent_mobile": null,
      "telephone": null,
      "balance": 0,
      "legal_national_code": null,
      "individual_national_code": "1234567890",
      "province_id": "8",
      "province": "تهران",
      "city_id": "6",
      "city": "تهران",
      "address": "تهران...",
      "postal_code": "1234567890",
      "mcc_code": null,
      "mcc_name": "-",
      "custom_fields": [
            {
                "key": "سن",
                "value": "25"
            },
            {
                "key": "تاریخ تولد",
                "value": "1376/01/01"
            }
      ]
  }
}

نمونه json برای ثبت نام مشتری حقوقی 

 {
     "legal_name": "تست",
     "agent_name": "نوروزی",
     "type": "LEGAL",
     "agent_mobile": "09121234567",
     "telephone": "",
     "legal_national_code": "1234567890",
     "province_id": "8",
     "city_id": "6",
     "address": "تهران",
     "postal_code": "",
     "custom_fields": [
        {"field_id": 1, "field_value": "25"},
        {"field_id": 2, "field_value": "01/01/1376"},
     ]
 }

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

 HTTP/1.1 200
 {
  "message": "مخاطب با موفقیت به‌روزرسانی شد.",
  "customer": {
      "name": "تست",
      "first_name": null,
      "last_name": null,
      "legal_name": "تست",
      "agent_name": "نوروزی",
      "type": "LEGAL",
      "mobile": null,
      "agent_mobile": "09121234567",
      "telephone": null,
      "balance": 0,
      "legal_national_code": "1234567890",
      "individual_national_code": null,
      "province_id": "8",
      "province": "تهران",
      "city_id": "6",
      "city": "تهران",
      "address": "تهران",
      "postal_code": "1234567890",
      "mcc_code": null,
      "mcc_name": "-",
      "custom_fields": [
            {
                "key": "سن",
                "value": "25"
            },
            {
                "key": "تاریخ تولد",
                "value": "1376/01/01"
            }
      ]
  }
}

در صورتی که از قبل فیلد اختصاصی برای کسب و کار ثبت نشده باشد خطای زیر برگردانده می شود: 

HTTP/1.1 422
{
    "message": "چنین فیلدی برای این کسب و کار ثبت نشده است.",
    "errors": {
        "custom_fields.0.field_id": [
            "چنین فیلدی برای این کسب و کار ثبت نشده است."
        ]
    }
}

۴. حذف مشتری

در صورت نیاز به حذف یک مشتری از این سرویس استفاده نمایید.

METHOD: DELETE
URL: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

HTTP/1.1 200
{
  "status": 1,
  "message": "مخاطب با موفقیت حذف گردید."
}

۵. نمایش اطلاعات مشتری

در این بخش امکان مشاهده اطلاعات یک مشتری را خواهید داشت.

Method: GET
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

HTTP/1.1 200
{
  "customer": {
      "name": "تست",
      "first_name": null,
      "last_name": null,
      "legal_name": "تست",
      "agent_name": "نوروزی",
      "type": "LEGAL",
      "mobile": null,
      "agent_mobile": "09121234567",
      "telephone": null,
      "balance": 0,
      "legal_national_code": "1234567890",
      "individual_national_code": null,
      "province_id": 8,
      "province": "تهران",
      "city_id": 6,
      "city": "تهران",
      "address": "تهران",
      "postal_code": "1234567890",
      "mcc_code": null,
      "mcc_name": "-",
      "custom_fields": [
            {
                "key": "سن",
                "value": "25"
            },
            {
                "key": "تاریخ تولد",
                "value": "1376/01/01"
            }
      ]
  }
}

فیلد اختصاصی

با استفاده از این سرویس می‌توانید فیلدهای اختصاصی برای کسب و کار ثبت نمایید.

۱. لیست فیلدها:

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

Method: GET
Address: https://api.vandar.io/v2/business/{business}/customers/fields

پارامتر {business} نام انگلیسی کسب و کار است.

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

HTTP/1.1 200
{
    "data": [
        {
            "id": 1,
            "name": "سن",
            "created_at": 1670222123,
            "updated_at": 1670222123
        },
        {
            "id": 2,
            "name": "تاریخ تولد",
            "created_at": 1670222052,
            "updated_at": 1670222052
        }
    ],
    "links": {
        "first": "https://customer.vandar.io/v2/business/{business}/customers/fields?page=1",
        "last": "https://customer.vandar.io/v2/business/{business}/customers/fields?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://customer.vandar.io/v2/business/{business}/customers/fields",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}
  • status: ما http response را مطابق آن‌چه که واقعاً اتفاق افتاده برای شما ارسال می‌کنیم؛ درخواست‌های موفقیت‌آمیز با ۲۰۰، خطاهای اعتبارسنجی را با ۴۲۲، خطای ۴۰۴ برای عدم یافتن منبعی خاص، خطاهای سمت سرور با ۵۰۰ و غیره.
  • data:
    • id: شناسه یکتای فیلد اختصاصی
    • name: نام فیلد اختصاصی.
    • created_at: تاریخ ثبت فیلد اختصاصی
    • updated_at: تاریخ ویرایش فیلد اختصاصی
  • links:
    • first: آدرس اولین صفحه
    • last: آدرس آخرین صفحه
    • prev: آدرس صفحه قبل
    • next: آدرس صفحه بعد
  • meta:
    • current_page: آدرس همین صفحه
    • from: شماره اولین آیتمی که در این صفحه آمده است
    • last_page: تعداد کل صفحات
    • path: آدرس خالص بدون صفحه بندی
    • per_page: تعداد آیتم در هر صفحه
    • to: شماره آخرین آیتمی که در این صفحه آمده است
    • total: تعداد کل آیتم ها

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

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

۲. ثبت فیلد اختصاصی جدید

با استفاده از این سرویس می‌توانید یک فیلد اختصاصی جدید ثبت نمایید. 

METHOD: POST
URL: https://api.vandar.io/v2/business/{business}/customers/fields

پارامتر {business} نام انگلیسی کسب و کار است.

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

name Type Status
name string required

توضیحات

  • name (اجباری): نام فیلد اختصاصی.

نمونه json برای ثبت فیلد اختصاصی 

{
    "name": "نام پدر"
}

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

HTTP/1.1 200
{
    "status": "1",
    "message": "فیلد با موفقیت ثبت گردید.",
    "result": {
        "field": {
            "id": 1
        }
    }
}

۳. ویرایش فیلد اختصاصی

با استفاده از این سرویس می‌توانید فیلد اختصاصی را ویراش نمایید. 

 METHOD: PUT
 URL: https://api.vandar.io/v2/business/{business}/customers/fields/{field}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {field} شناسه یکتای فیلد اختصاصی می‌باشد.

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

name Type Status
name string required

توضیحات

  • name (اجباری): نام فیلد اختصاصی.

نمونه json برای ویرایش فیلد اختصاصی 

{
    "name": "تاریخ تولد"
}

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

 HTTP/1.1 200
 {
    "message": "فیلد با موفقیت به‌روزرسانی شد.",
    "field": {
        "id": 1,
        "name": "تاریخ تولد",
        "created_at": 1670222052,
        "updated_at": 1670225515
    }
}

۴. حذف فیلد اختصاصی

در صورت نیاز به حذف یک فیلد اختصاصی از این سرویس استفاده نمایید.

METHOD: DELETE
URL: https://api.vandar.io/v2/business/{business}/customers/fields/{field}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {field} شناسه یکتای فیلد اختصاصی می‌باشد.

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

HTTP/1.1 200
{
    "status": 1,
    "message": "فیلد با موفقیت حذف گردید."
}

۵. نمایش فیلد اختصاصی

در این بخش امکان مشاهده اطلاعات یک فیلد اختصاصی را خواهید داشت.

Method: GET
Address: https://api.vandar.io/v2/business/{business}/customers/fields/{field}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {field} شناسه یکتای فیلد اختصاصی می‌باشد.

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

HTTP/1.1 200
{
    "data": {
        "id": 1,
        "name": "تاریخ تولد",
        "created_at": 1670222052,
        "updated_at": 1670225515
    }
}

کیف پول

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

۱. موجودی کیف پول

در این یخش امکان مشاهده موجدی کیف پول مشتری را خواهید داشت.

Method: GET
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/wallet

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

HTTP/1.1 200
{
  "status": 1,
  "balance": 0,
  "currency": "RIAL"
}

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

در صورتی که شناسه مشتری به اشتباه داده شود خطای ۴۰۴ دریافت می‌کنید.

HTTP/1.1 422
{
  "status": 0,
  "message": "خطای 404 رخ داده است."
}

۲. واریز به کیف پول

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

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/wallet/deposit

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

name Type Status
amount integer required min=1
comment string optional
track_id string required
  • توضیحات:
    • amount (اجباری): مبلغی که می‌خواهید به کیف پول مشتری اضافه شود.
    • comment (اختیاری): توضیحات مربوط به تراکنش واریزی
    • track_id (اجباری): شماره پیگیری غیرتکراری

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

HTTP/1.1 200
{
  "id": "0cf235d0-d48b-11ea-86cd-298ec898a9bd",
  "track_id": "123456",
  "status": 1,
  "message": "واریز با موفقیت انجام شد",
  "balance": 1000,
  "currency": "RIAL",
  "comment": "comment",
}

۲. برداشت از کیف پول

در صورت نیاز به پایین آرودن موجودی کیف پول مشتری می‌توانید با استفاده از این سرویس، یک تراکنش برداشت از کیف پول مشتری ثبت نمایید. 

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/wallet/withdraw

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

name Type Status
amount integer required min=1
comment string optional
track_id string required
  • توضیحات:
    • amount (اجباری): مبلغی که می‌خواهید از کیف پول مشتری کم شود.
    • comment (اختیاری): توضیحات مربوط به تراکنش برداشتی
    • track_id (اجباری): شماره پیگیری غیرتکراری

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

HTTP/1.1 200
{
  "id": "0cf235d0-d48b-11ea-86cd-298ec898a9bd",
  "track_id": "123456",
  "status": 1,
  "message": "برداشت با موفقیت انجام شد",
  "balance": 1000,
  "currency": "RIAL",
  "comment": "comment"
}

تراکنش

در این بخش اطلاعات تراکنش‌های مشتریان قابل مشاهده می‌باشد.

۱. لیست تراکنش‌ها

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

Method: GET
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/transactions

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

HTTP/1.1 200
{
  "data": [
      {
          "uuid": "7641090d-41f4-48dd-8908-ce06560ffde3",
          "type": "withdraw",
          "amount": -1000,
          "comment": "کاهش کیف پول مشتری",
          "balance": "1000",
          "created_at": 1633082125,
          "updated_at": 1633082125
      },
      {
          "uuid": "f47f9242-968e-4cbf-902f-0e38ac9c3a3f",
          "type": "deposit",
          "amount": 1000,
          "comment": "افزایش کیف پول مشتری",
          "balance": "2000",
          "created_at": 1633081476,
          "updated_at": 1633081476
      },
      {
          "uuid": "7e86df2a-2870-47a7-aece-9d3e63bc5e73",
          "type": "deposit",
          "amount": 1000,
          "comment": "افزایش کیف پول مشتری",
          "balance": "1000",
          "created_at": 1633081255,
          "updated_at": 1633081255
      }
  ],
  "links": {
      "first": "https://customer.vandar.io/v2/business/{business}/customers/394dd280-210f-11ec-96d5-95b80dce5a5a/transactions?page=1",
      "last": "https://customer.vandar.io/v2/business/{business}/customers/394dd280-210f-11ec-96d5-95b80dce5a5a/transactions?page=1",
      "prev": null,
      "next": null
  },
  "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 1,
      "path": "https://customer.vandar.io/v2/business/{business}/customers/394dd280-210f-11ec-96d5-95b80dce5a5a/transactions",
      "per_page": 20,
      "to": 3,
      "total": 3
  },
  "status": 1
}
  • data:
    • uuid: شناسه یکتای مشتری
    • type: نوع تراکنش که شامل واریز(deposit) و برداشت (withdraw) می‌باشد
    • amount: مبلغ تراکنش
    • comment: توضیحات تکمیلی تراکنش
    • balance: موجودی کیف پول مشتری بعد از انجام آن تراکنش
    • created_at: تاریخ انجام تراکنش
    • updated_at: تاریخ ویراش تراکنش
  • links:
    • first: آدرس اولین صفحه
    • last: آدرس آخرین صفحه
    • prev: آدرس صفحه قبل
    • next: آدرس صفحه بعد
  • meta:
    • current_page: آدرس همین صفحه
    • from: شماره اولین آیتمی که در این صفحه آمده است
    • last_page: تعداد کل صفحات
    • path: آدرس خالص بدون صفحه بندی
    • per_page: تعداد آیتم در هر صفحه
    • to: شماره آخرین آیتمی که در این صفحه آمده است
    • total: تعداد کل آیتم ها

شبا

۱. ثبت شماره شبا

با استفاده از این سرویس می‌توانید برای مشتری شماره شبا ثبت نمایید. 

Method: POST
Address: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

name Type Status
iban string required
is_default boolean required
has_inquiry boolean required
first_name string required if has_inquiry=true and customer first_name=null
last_name string required if has_inquiry=true and customer last_name=null
legal_name string required if has_inquiry=true and customer legal_name=null
  • توضیحات:
    • iban (اجباری): شماره شبا مشتری.
    • is_default (اجباری): تعیین شماره شبا پیش فرض.
    • has_inquiry (اجباری): تعیین کننده استعلام شماره شبا در لحظه.
    • first_name: در صورتی که فیلد has_inquiry برابر true باشد و مشتری از نوع حقیقی باشد و نام مشتری خالی باشد این فیلد اجباری است.
    • last_name: در صورتی که فیلد has_inquiry برابر true باشد و مشتری از نوع حقیقی باشد و نام خانوادگی مشتری خالی باشد این فیلد اجباری است.
    • legal_name: در صورتی که فیلد has_inquiry برابر true باشد و مشتری از نوع حقوقی باشد و نام حقوقی مشتری خالی باشد این فیلد اجباری است.

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

HTTP/1.1 200
{
    "iban": "IR880620000000001780000000",
    "is_default": true,
    "iban_compatibility": "UNMATCHED",
    "account_owners": [
        {
            "firstName": "الناز",
            "lastName": "نوروزی"
        }
    ],
    "created_at": 1669185629,
    "updated_at": 1669185629
}
  • iban: شماره شبا
  • is_default: تعیین کننده شماره شبا پیش فرض
  • iban_compatibility: تعیین کننده تطابق شماره شبا با اطلاعات مشتری که شامل 3 وضعیت UNKNOWN و MATCHED و UNMATCHED می باشد. مقدار UNKNOWN در صورتی برگردانده می شود که پارامتر has_inquiry برابر false باشد.
  • account_owners: لیستی از صاحبان شماره شبا
  • created_at: تاریخ ثبت شماره شبا
  • updated_at: تاریخ ویراش شماره شبا

۲. لیست شماره شباها

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

  Method: GET
  Address: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans

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

  HTTP/1.1 200
  {
    "data": [
        {
            "iban": "IR880620000000001780000000",
            "is_default": true,
            "iban_compatibility": "UNMATCHED",
            "account_owners": [
                {
                    "firstName": "الناز",
                    "lastName": "نوروزی"
                }
            ],
            "created_at": 1669185629,
            "updated_at": 1669185629
        }
    ],
    "links": {
        "first": "https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans?page=1",
        "last": "https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« قبلی",
                "active": false
            },
            {
                "url": "https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "بعدی »",
                "active": false
            }
        ],
        "path": "http://api.vandar.local/v3/business/{business}/customers/{customer_uuid}/ibans",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

۳. حذف شماره شبا

در صورت نیاز می‌توانید از این بخش شماره شبا مربوط به مشتری را حدف نمایید.

   METHOD: DELETE
   URL: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans/{iban}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

پارامتر {iban} شماره شبا مشتری می‌باشد.

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

   HTTP/1.1 200
   {
       "message": "شماره شبا با موفقیت حذف شد."
   }

۴. استعلام شماره شبا

در صورت نیاز می‌توانید از این بخش شماره شبا مربوط به مشتری را استعلام نمایید.

   METHOD: POST
   URL: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans/{iban}/inquiry

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

پارامتر {iban} شماره شبا مشتری می‌باشد.

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

name Type Status
first_name string required if customer first_name=null
last_name string required if customer last_name=null
legal_name string required if customer legal_name=null
  • توضیحات:
    • first_name: در صورتی که مشتری از نوع حقیقی باشد و نام مشتری خالی باشد این فیلد اجباری است.
    • last_name: در صورتی که مشتری از نوع حقیقی باشد و نام خانوادگی مشتری خالی باشد این فیلد اجباری است.
    • legal_name: در صورتی که مشتری از نوع حقوقی باشد و نام حقوقی مشتری خالی باشد این فیلد اجباری است.

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

   HTTP/1.1 200
   {
    "iban_compatibility": "UNMATCHED",
    "account_owners": [
        {
            "firstName": "الناز",
            "lastName": "نوروزی"
        }
    ]
}

۵. تنظیم شماره شبا پیش فرض

در صورت نیاز می‌توانید از این بخش شماره شبا مربوط به مشتری را به صورت پیش فرض تنظیم نمایید.

   METHOD: POST
   URL: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/ibans/{iban}/set-default

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

پارامتر {iban} شماره شبا مشتری می‌باشد.

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

   HTTP/1.1 200
   {
       "message": "این شماره شبا به صورت پیش فرض تنظیم شد."
   }

تبدیل شماره کارت به شبا

با استفاده از این سرویس می‌توانید از شماره کارت به شماره شبا پشت کارت برسید. 

Method: POST
Address: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards/to-iban

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

  • در حا حاضر این سرویس برای شماره کارت ها از بانک های زیر قابل استفاده است:
    • بانک اقتصاد نوین
    • بانک کشاورزی
    • بانک سامان
    • بانک سرمایه
    • بانک صادرات
    • بانک رسالت
    • بانک دی
    • بانک انصار
    • بانک شهر
    • بانک تجارت
    • بانک ایران زمین
    • بانک سینا
    • بانک صنعت و معدن
    • بانک پاسارگاد
    • بانک ملی

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

name Type Status
card string required
is_default boolean required
has_inquiry boolean required
  • توضیحات:
    • card (اجباری): شماره کارت مشتری.
    • is_default (اجباری): تعیین شماره کارت پیش فرض.
    • has_inquiry (اجباری): تعیین کننده استعلام شماره کارت در لحظه.

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

HTTP/1.1 200
{
    "iban": "IR610550018180006734170001",
    "is_default": true,
    "iban_compatibility": "UNMATCHED",
    "account_owners": [
        {
            "lastName": "شهرياري فرد",
            "firstName": "محمد"
        }
    ],
    "bank_name": null,
    "account_description": null,
    "account_number": null,
    "created_at": 1672655515,
    "updated_at": 1672655517
}
  • iban: شماره شبا
  • is_default: تعیین کننده شماره شبا پیش فرض
  • iban_compatibility: تعیین کننده تطابق شماره شبا با اطلاعات مشتری که شامل 3 وضعیت UNKNOWN و MATCHED و UNMATCHED می باشد. مقدار UNKNOWN در صورتی برگردانده می شود که پارامتر has_inquiry برابر false باشد.
  • account_owners: لیستی از صاحبان شماره شبا
  • created_at: تاریخ ثبت شماره شبا
  • updated_at: تاریخ ویراش شماره شبا

کارت

۱. ثبت شماره کارت

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

Method: POST
Address: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

name Type Status
card string required
is_default boolean required
has_inquiry boolean required
first_name string required if has_inquiry=true and customer first_name=null
last_name string required if has_inquiry=true and customer last_name=null
legal_name string required if has_inquiry=true and customer legal_name=null
  • توضیحات:
    • card (اجباری): شماره کارت مشتری.
    • is_default (اجباری): تعیین شماره کارت پیش فرض.
    • has_inquiry (اجباری): تعیین کننده استعلام شماره کارت در لحظه.
    • first_name: در صورتی که فیلد has_inquiry برابر true باشد و مشتری از نوع حقیقی باشد و نام مشتری خالی باشد این فیلد اجباری است.
    • last_name: در صورتی که فیلد has_inquiry برابر true باشد و مشتری از نوع حقیقی باشد و نام خانوادگی مشتری خالی باشد این فیلد اجباری است.
    • legal_name: در صورتی که فیلد has_inquiry برابر true باشد و مشتری از نوع حقوقی باشد و نام حقوقی مشتری خالی باشد این فیلد اجباری است.

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

HTTP/1.1 200
{
    "card": "5648125647856214",
    "is_default": true,
    "card_compatibility": "UNMATCHED",
    "name": "الناز نوروزی",
    "created_at": 1669185629,
    "updated_at": 1669185629
}
  • card: شماره کارت
  • is_default: تعیین کننده شماره کارت پیش فرض
  • card_compatibility: تعیین کننده تطابق شماره کارت با اطلاعات مشتری که شامل 3 وضعیت UNKNOWN و MATCHED و UNMATCHED می باشد. مقدار UNKNOWN در صورتی برگردانده می شود که پارامتر has_inquiry برابر false باشد.
  • name: نام صاحب شماره کارت
  • created_at: تاریخ ثبت شماره کارت
  • updated_at: تاریخ ویراش شماره کارت

۲. لیست شماره کارت ها

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

  Method: GET
  Address: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards

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

  HTTP/1.1 200
  {
    "data": [
        {
            "card": "5648125647856214",
            "is_default": true,
            "card_compatibility": "UNMATCHED",
            "name": "الناز نوروزی",
            "created_at": 1669185629,
            "updated_at": 1669185629
        }
    ],
    "links": {
        "first": "https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards?page=1",
        "last": "https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« قبلی",
                "active": false
            },
            {
                "url": "https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "بعدی »",
                "active": false
            }
        ],
        "path": "http://api.vandar.local/v3/business/{business}/customers/{customer_uuid}/cards",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

۳. حذف شماره کارت

در صورت نیاز می‌توانید از این بخش شماره کارت مربوط به مشتری را حدف نمایید.

   METHOD: DELETE
   URL: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards/{card}

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

پارامتر {card} شماره کارت مشتری می‌باشد.

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

   HTTP/1.1 200
   {
       "message": "شماره کارت با موفقیت حذف شد."
   }

۴. استعلام شماره کارت

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

   METHOD: POST
   URL: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards/{card}/inquiry

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

پارامتر {card} شماره کارت مشتری می‌باشد.

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

name Type Status
first_name string required if customer first_name=null
last_name string required if customer last_name=null
legal_name string required if customer legal_name=null
  • توضیحات:
    • first_name: در صورتی که مشتری از نوع حقیقی باشد و نام مشتری خالی باشد این فیلد اجباری است.
    • last_name: در صورتی که مشتری از نوع حقیقی باشد و نام خانوادگی مشتری خالی باشد این فیلد اجباری است.
    • legal_name: در صورتی که مشتری از نوع حقوقی باشد و نام حقوقی مشتری خالی باشد این فیلد اجباری است.

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

   HTTP/1.1 200
{
    "card_compatibility": "MATCHED",
    "name": "الناز نوروزی"
}

۵. تنظیم شماره کارت پیش فرض

در صورت نیاز می‌توانید از این بخش شماره کارت مربوط به مشتری را به صورت پیش فرض تنظیم نمایید.

   METHOD: POST
   URL: https://api.vandar.io/v3/business/{business}/customers/{customer_uuid}/cards/{card}/set-default

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

پارامتر {card} شماره کارت مشتری می‌باشد.

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

   HTTP/1.1 200
   {
       "message": "این شماره کارت به صورت پیش فرض تنظیم شد."
   }

احراز هویت

این سرویس جهت احراز هویت طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان می‌توانند اطلاعات هویتی مخاطبان خود را مورد سنجش قرار دهند.

در حال حاضر وب سرویس احراز هویت مخاطبین به دو دسته کلی تقصیم شده است:

  • مخاطبینی که از قبل توسط پذیرنده ثبت نام شده اند.
  • مخاطبینی که ثبت نام نشده اند.

انواع احراز هویت:

  • کی وای سی (KYC)
    • این سرویس با دریافت نام , نام خانوادگی , کد ملی و تاریخ تولد اطلاعات هویتی کاربر را مورد سنجش قرار میدهد
  • شاهکار (SHAHKAR)
    • این سرویس با دریافت شماره تلفن همراه و کد ملی اطلاعات هویتی کاربر را مورد سنجش قرار میدهد

نحوه استفاده از وب سرویس احراز هویت

برای احراز هویت کاربرانی که از قبل توسط پذیرنده ثبت نام شده اند احتیاجی به وارد کردن اطلاعات مخاطب نیست بلکه اطلاعات مخاطبین واکشی شده و در صورت وجود نقض یا مغایرت وب سرویس پیغام مناسب بر می گرداند.

برای احراز هویت مخاطبینی که از قبل توسط پذیرنده ثبت نام نشده اند وارد کردن اطلاعات مربوط به هر سرویس الزامی است.

احراز هویت کی وای سی (KYC)

وب سرویس احراز هویت برای مخاطبینی که ثبت نام شده اند:

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/authentication/kyc

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

وب سرویس احراز هویت برای مخاطبینی که ثبت نام نشده اند:

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/authentication/kyc

پارامتر {business} نام انگلیسی کسب و کار است.

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

name Type Status
first_name string required
last_name string required
individual_national_code string required
birthday string required
  • توضیحات:
    • first_name (اجباری): نام مخاطب.
    • last_name (اجباری): نام خانوادگی مخاطب.
    • individual_national_code (اجباری): کد ملی مخاطب.
    • birthday (اجباری): تاریخ تولد جلالی مخاطب.

احراز هویت شاهکار (SHAHKAR)

وب سرویس احراز هویت برای مخاطبینی که ثبت نام شده اند:

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/authentication/shahkar

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

وب سرویس احراز هویت برای مخاطبینی که ثبت نام نشده اند:

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/authentication/shahkar

پارامتر {business} نام انگلیسی کسب و کار است.

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

name Type Status
individual_national_code string required
mobile string required
  • توضیحات:
    • individual_national_code (اجباری): کد ملی مخاطب.
    • mobile (اجباری): شماره تلفن همراه مخاطب.

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

HTTP/1.1 200
{
    "status": "1",
    "authentication_status": "SUCCESSFUL",
    "message": "اطلاعات احراز هویت کاربر با موفقیت واکشی شد"
}
  • status: در صورت موفقیت آمیز بودن درخواست عدد 1 و در غیر اینصورت عدد 0 را نمایش خواهد داد.
  • authentication_status: تعیین کننده تطابق اطلاعات هویتی ارسالی با اطلاعات مخاطب که شامل 3 وضعیت SUCCESSFUL و FAILURE و PENDING و NOT_FOUND می باشد. در صورت تطابق اطلاعات SUCCESSFUL , در صورت عدم تطابق اطلاعات FAILURE , در صورت عدم پاسخگویی سرور احراز هویت PENDING و در صورت بروز خطا یا عدم وجود اطلاعات استعلامی NOT_FOUND نمایش داده خواهد شد.

گزارشات

این سرویس جهت گزارش گیری از طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان می‌توانند گزارش های مربوط به مخاطبان خود را مشاهده کنند. 

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/logs

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

  HTTP/1.1 200
  {
    "data": [
        {
            "type": "CUSTOMER_UPDATED",
            "description": "مخاطب با موفقیت ویرایش شد",
            "created_at": 1670156241,
            "updated_at": 1670156241
        }
    ],
    "links": {
        "first": "https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/logs?page=1",
        "last": "https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/logs?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« قبلی",
                "active": false
            },
            {
                "url": "https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/logs?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "بعدی »",
                "active": false
            }
        ],
        "path": "http://api.vandar.local/v2/business/{business}/customers/{customer_uuid}/logs",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}
  • type: نوع گزارش ایجاد شده برای مخاطب را نمایش می دهد.
    1. CUSTOMER_CREATED: گزارش ایجاد مخاطب
    2. CUSTOMER_UPDATED: گزارش ویرایش مخاطب
    3. CUSTOMER_KYC_AUTHENTICATION_REQUEST: گزارش درخواست احراز هویت کی وای سی مخاطب
    4. CUSTOMER_SHAHKAR_AUTHENTICATION_REQUEST: گزارش درخواست احراز هویت کی شاهکار مخاطب
  • description: توضیحات مربوط به گزارش مخاطب را نمایش میدهد.

شناسه پرداخت

این سرویس جهت ایجاد شناسه پرداخت و انتصاب آن به طرف‌حساب‌های پذیرندگان وندار ارائه شده است که توسط آن، پذیرندگان می‌توانند به ازای هر مشتری یک شناسه پرداخت منحصر به فرد ایجاد کنند.

۱. ایجاد شناسه پرداخت

با استفاده از این سرویس می‌توانید برای مشتری شناسه پرداخت جدید ایجاد نمایید. 

Method: POST
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/cash-in-code

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

HTTP/1.1 200
{
    "status": 1,
    "code": "143992020000736",
    "message": "شناسه پرداخت با موفقیت ایجاد شد"
}
  • code: شناسه پرداخت منحصر به فرد مشتری

۲. لیست شناسه پرداخت

با استفاده از این سرویس می‌توانید شناسه پرداخت مشتریان را ملاحظه نمایید. 

Method: GET
Address: https://api.vandar.io/v2/business/{business}/customers/{customer_uuid}/cash-in-code

پارامتر {business} نام انگلیسی کسب و کار است.

پارامتر {customer_uuid} شناسه یکتای مشتری می‌باشد که از طریق سرویس مشاهده لیست مشتریان قابل دسترسی می‌باشد.

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

HTTP/1.1 200
{
    "status": 1,
    "code": "143992020000736",
    "message": "شناسه پرداخت مشتری با موفقیت واکشی شد."
}
  • code: شناسه پرداخت منحصر به فرد مشتری