مقدمه

API های وندار بر اساس استاندارد REST ایجاد شده اند.

تمامی پاسخ API های ما بصورت JSON-encoded پاسخ داده خواهند شد.

بوسیله ارسال توکن در هر درخواست، احراز هویت نیز انجام می شود. (ممکن است در برخی از سرویس ها نحوه احراز هویت متفاوت باشد)

محدودیت های درخواست به API

برای متد POST در هر ۳ ثانیه ۳۰ درخواست

و برای باقی متد ها در هر ۳ ثانیه ۱۰۰ درخواست قابل پذیرش است.

توجه داشته باشید که در حال حاضر برخی از مسیرها با base url روبرو تعیین نشده است.

آیا این بخش مفید بود؟بلی خیر
BASE URL

https://api.vandar.io

احراز هویت

برای دریافت توکن و رفرش توکن اولیه مالک یا مدیر کسب و کار می تواند وارد داشبورد وندار شود و کسب و کار خود را انتخاب کند. و از منوی تنظیمات بخش تنظیمات مدیریت حساب، توکن ها را انتخاب کنید. و با زدن دکمه افزودن توکن جدید، و وارد کردن یک نام برای توکن و وارد کردن رمز عبور حساب کاربری خود یک توکن و رفرش توکن در یافت کنید.

از آنجاییکه عمر توکن ها محدود است و مقدار آن در فیلد expires_in (بر مبنای ثانیه) همراه توکن ارسال شده است،‌ باید قبل از منقضی شدن توکن با ارسال رفرش توکن، توکن جدید را دریافت کنید.

پارامترها
refreshtokenrequiredstring

مقداری که از فراخوانی متد قبل دریافت کرده‌اید

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'POST',
  url: '/v3/refreshtoken',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    refreshtoken: '{refreshtoken}'
  })
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "token_type": "Bearer",
  "expires_in": 432000,
  "access_token": "bPJO9cJLGRqClDadEua7ztoCLC5E***********",
  "refresh_token": "def50200c4d2462d2de167da1*******"
}

خطاها

API های وندار از قواعد HTTP response پیروی می‌کند.

بطور کلی در رنج 2xx پاسخ های موفق را دریافت می‌کنید.

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

خطاهایی در رنج 5xx نشان دهنده مشکلاتی از سمت API های وندار بوده که می توانید آن را با پشتیبانی مطرح کنید.

آیا این بخش مفید بود؟بلی خیر
HTTP STATUS CODE SUMMARY

200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
402 - Request FailedThe parameters were valid but the request failed.
403 - ForbiddenThe API key doesn't have permissions to perform the request.

درگاه پرداخت IPG

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

نکته

برای استفاده از درگاه پرداخت لازم است این ابزار را در داشبورد وندار فعال کرده و یک توکن دریافت کنید.

قبل از شروع پیاده سازی بهتر است یک بار فرایند پرداخت را با هم مرور کنیم
  • مرحله اول: ارسال اطلاعات تراکنش و دریافت توکن پرداخت.
  • مرحله دوم: انتقال کاربر به صفحه پرداخت با توکنی که از مرحله اول دریافت کردید.
  • مرحله سوم (اختیاری): قبل از تایید تراکنش اطلاعات تراکنش را دریافت می‌کنید.
  • مرحله چهارم: بعد از فرایند پرداخت کاربر به آدرسی بازگشتی که در مرحله اول ارسال کردید، بر‌میگردد. و شما برای نهایی شدن تراکنش حتما باید متد وریفای تراکنش رو صدا بزنید. و نتیجه نهایی تراکنش را دریافت کنید. پایان تراکنش

این چهار مرحله کلی مقدمه چهار نکته مهم است که توجه شما را به این نکات جلب می‌کنم

تعداد زیادی از کسب و کارها قبل از تایید یک تراکنش و نهایی کردن اون ممکنه به اطلاعات تراکنش نیاز داشته باشند. به عنوان مثال اگر بخواهید شماره کارت پرداخت کننده را قبل از نهایی کردن تراکنش صحت سنجی کنید مرحله سوم که دریافت اطلاعات شماره کارت است رو فراخوانی می‌کنید و پارامتر "cid" که هش "SHA256" شماره کارت است را با شماره کارتی که پرداخت کننده از قبل نزد شما ثبت کرده است، تطابق می‌دهید. اما اگر به این صحت سنجی نیاز نداشته باشید. فراخوانی این سرویس اختیاری است.

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

این ورژن آخرین ورژن درگاه پرداخت وندار است. ورژن های قدیمی وندار پابرجا است. اما با توجه به تغییرات انجام شده سرعت انجام تراکنش در این ورژن بالاتر است. و این ورژن قابلیت های درگاه پرداخت دومرحله ای و تک مرحله ای را همزمان داراست. به هیچ عنوان در ورودی و خروجی ها تغییر داده نشده است. پس فقط با تغییر آدرس می‌توانید به ورژن ۳ مهاجرت کنید.

در صورتیکه تمایل به استفاده از قابلیت سوئیچینگ هوشمند درگاه پرداخت دارید این موضوع را به پشتیبانی وندار اطلاع دهید تا برای شما فعال کنند.

آیا این بخش مفید بود؟بلی خیر
endpoints

POST https://ipg.vandar.io/api/v3/send

GET https://ipg.vandar.io/v3/:token

POST https://ipg.vandar.io/api/v3/transaction

POST https://ipg.vandar.io/api/v3/verify

تسویه

با استفاده از سرویس تسویه می‌توانید مبلغ موردنظر از کیف پول کسب و کار خود به مقصد شبای دلخواه (تمامی شباهای سامانه بانکی کشور) واریز نمائید.

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/settlement/store

GET /v2.1/business/:business/settlement

DELETE /v2.1/business/:business/settlement/:transaction_id

GET /v3/business/:business/settlement/banks

تسویه گروهی

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST https://batch.vandar.io/api/v2/business/:business_name/batches-settlement

GET https://batch.vandar.io/api/v2/business/:business_name/batches

GET https://batch.vandar.io/api/v2/business/:business_name/batch-settlements/:batch_id

تسویه در نوبت

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business_name/settlement/queued

GET /v3/business/:business_name/settlement/queued

GET /v3/business/:business_name/settlement/queued/:settlement_queued_id

POST /v3/business/:business_name/settlement/queued/cancel

ابزار واریز بانکی

ابزار «واریز بانکی» یا به اصطلاح ،cash in یکی از بهترین روش‌های شارژ کیف پول کسب‌وکار ها است. کسب‌ و کارهایی که مبالغ زیادی از حساب آن‌ها برداشته می‌شود، با استفاده از این ویژگی می‌توانند مبلغی را از حساب بانک آینده خود به کیف پول خود در وندار اضافه کرده و پس از آن تعیین کنند که چه مقدار وجه از کیف پول‌شان خارج شود.

آیا این بخش مفید بود؟بلی خیر
endpoints

GET /v3/business/:business/cash-in/account

POST /v3/business/:business/cash-in/account/deposit

POST /v3/business/:business/cash-in/account/balance

پرداخت خودکار

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

آیا این بخش مفید بود؟بلی خیر

بانک‌ها

لیست بانک‌های فعال دایرکت‌دبیت برای کسب‌وکار شما از طریق این سرویس قابل دسترس می‌باشد. همچنین امکان مدیریت بانک‌ها در داشبورد وندار، بخش پرداخت خودکار فراهم می‌باشد.

آیا این بخش مفید بود؟بلی خیر
endpoints

GET /v3/business/:business/subscription/banks/actives

مجوز پرداخت از حساب

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/subscription/authorization/store

GET https://subscription.vandar.io/authorizations/:token

PATCH /v3/business/:business/subscription/authorization/:id/verify

GET /v3/business/:business/subscription/authorization

GET /v3/business/:business/subscription/authorization/:id

DELETE /v3/business/:business/subscription/authorization/:id

پرداخت از حساب

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/subscription/withdrawal/store

GET /v3/business/:business/subscription/withdrawal/:id

GET /v3/business/:business/subscription/withdrawal/track-id/:track_id

GET /v3/business/:business/subscription/withdrawal

GET /v3/business/:business/subscription/withdrawal?q=:authorization_id

PUT /v3/business/:business/subscription/withdrawal/:id

معامله امن «میاندو»

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

آیا این بخش مفید بود؟بلی خیر

مشتریان

مشتریان در میاندو به اشخاصی اطلاق می‌شود که به عنوان طرفین معامله (خریدار، فروشنده) به خرید و فروش می‌پردازند.

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /miando/api/v1/customers

GET /miando/api/v1/customers

GET /miando/api/v1/customers/:id

معاملات

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /miando/api/v1/agreements

POST /miando/api/v1/agreements/:tracking_code

POST /miando/api/v1/agreements/:tracking_code/finalize

POST /miando/api/v1/agreements/:tracking_code/cancel

GET /miando/api/v1/agreements

GET /miando/api/v1/agreements/:tracking_code

تیکت

اگر در روند معامله مشکلی پیش آمد می‌توانید با ثبت تیکت مشکل خود را بیان کنید.

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /miando/api/v1/tickets

مشتریان

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

آیا این بخش مفید بود؟بلی خیر
endpoints

GET /v2/business/:business/customers

POST /v2/business/:business/customers

PUT /v2/business/:business/customers/:customer_uuid

DELETE /v2/business/:business/customers/:customer_uuid

GET /v2/business/:business/customers/:customer_uuid

فیلد اختصاصی

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

آیا این بخش مفید بود؟بلی خیر
endpoints

GET /v2/business/business/customers/fields

POST /v2/business/:business/customers/fields

PUT /v2/business/:business/customers/fields/:fields

DELETE /v2/business/:business/customers/fields/:fields

GET /v2/business/:business/customers/fields/:fields

کیف پول

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

آیا این بخش مفید بود؟بلی خیر
endpoints

GET /v2/business/:business/customers/:customer_uuid/wallet

POST /v2/business/:business/customers/:customer_uuid/wallet/deposit

POST /v2/business/:business/customers/:customer_uuid/wallet/withdraw

تراکنش‌ها

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v2/business/:business/customers/:customer_uuid/transactions

شبا

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/customers/:customer_uuid/ibans

GET /v3/business/:business/customers/:customer_uuid/ibans

DELETE /v3/business/:business/customers/:customer_uuid/ibans

POST /v3/business/:business/customers/:customer_uuid/ibans/:iban/inquiry

POST /v3/business/:business/customers/:customer_uuid/ibans/:iban/set-default

POST /v3/business/:business/customers/:customer_uuid/cards/to-iban

کارت

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/customers/:customer_uuid/cards

GET /v3/business/:business/customers/:customer_uuid/cards

DELETE /v3/business/:business/customers/:customer_uuid/cards/:card

POST /v3/business/:business/customers/:customer_uuid/cards/:card/inquiry

POST /v3/business/:business/customers/:customer_uuid/cards/:card/set-default

احراز هویت

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

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

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

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

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/customers/:customer_uuid/authentication/kyc

POST /v3/business/:business/customers/authentication/kyc

POST /v3/business/:business/customers/:customer_uuid/authentication/shahkar

POST /v3/business/:business/customers/authentication/shahkar

گزارشات

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v2/business/{business}/customers/{customer_uuid}/logs

شناسه پرداخت

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

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/customers/:customer_uuid/cash-in-code

GET /v3/business/:business/customers/:customer_uuid/cash-in-code

استعلام ها

سرویس استعلام مشتریان

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/customers/inquiry/national-code

POST /v3/business/:business/customers/inquiry/postal-code

POST /v3/business/:business/customers/national-code-iban-inquiry

استعلام هویت با هوش مصنوعی

استعلام هویت براساس هوش مصنوعی

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/customers/inquiry/kyc/face-recognition-by-image

POST /v3/business/:business/customers/inquiry/kyc/face-recognition-by-video

POST /v3/business/:business/customers/inquiry/kyc/face-match-with-national-card

POST /v3/business/:business/customers/inquiry/kyc/random-gesture

استعلام با OCR

استعلام هویت براساس کدملی و تاریخ تولد

آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/customers/inquiry/kyc/ocr/national-card

POST /v3/business/:business/customers/inquiry/kyc/ocr/credit-card

POST /v3/business/:business/customers/inquiry/kyc/ocr/face-recognition

POST /v3/business/:business/customers/inquiry/kyc/ocr/civil-registration

POST /v3/business/:business/customers/inquiry/kyc/ocr/postal-code

صورت حساب

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

آیا این بخش مفید بود؟بلی خیر
endpoints

GET /v2/business/:business/balance

GET /v3/business/:business/transaction

کیف پول

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

پارامترها
businessrequiredstring

نام انگلیسی کسب و کار

پاسخ ها
statusinteger

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

walletstring

مقدار کیف پول کسب کار به تومان

currencyinteger

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

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'GET',
  url: '/v2/business/:business/balance',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  }
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
  "status": 1,
  "data": {
    "wallet": 100000,
    "currency": "Toman"
  }
}

لیست تراکنش‌ها و تسویه‌ها

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

پارامترها
businessrequiredstring

نام انگلیسی کسب و کار

fromDatestring

شروع بازه زمانی با فرمت 14000102

toDatestring

پایان بازه زمانی با فرمت 14000201

statusKindstring

این پارامتر مشخص کننده نوع تراکنش می‌باشد

statusstring

مشخص کننده وضعیت تراکنش یا تسویه می‌باشد

channelstring

این پارامتر مشخص می‌کند که تراکنش از چه کانالی انجام شده است

formIdstring

شناسه فرم پرداخت

ref_idrequiredstring

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

tracking_coderequiredstring

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

idrequiredstring

شناسه یکتای تراکنش

track_idrequiredstring

کد رهگیری در زمان ثبت تسویه

factor_numberrequiredstring

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

per_pagerequiredstring

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

پارامترهای بیشتر

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

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

محدوده ی جستجو

پاسخ ها
statusinteger

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

has_moreboolean

در صورتی عناصر بیشتری از مجموعه وجود دارد این مقدار برابر با true می باشد. در غیر اینصورت مقدار false برگشت داده می شود. در صورت true بودن می توانید از پارامتر ورودی start_after در ورودی استفاده کنید

idinteger

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

uuidstring

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

amountinteger

مبلغ کل تراکنش به تومان

wageinteger

کارمزد تراکنش به تومان

statusinteger

نوع تراکنش را مشخص می‌کند

ref_idinteger

شناسه مرجع تراکنش یا تسویه

tracking_codeinteger

کد پیگیری تراکنش

verifiedinteger

در صورت استفاده از درگاه پرداخت دو مرحله‌ای تراکنش تایید شود این مقدار برابر با ۱ می‌باشد در غیر این‌صورت برابر با ۰ می باشد. در درگاه پرداخت تک مرحله‌ای بلافاصله بعد از انجام تراکنش این مقدار ۱ می‌شود

channelstring

توضیحات فارسی نوع تراکنش

payment_datestring

تاریخ و زمان اتمام تراکنش

effective_time_stampinteger

مقدار timestamp تاریخ و زمان اتمام تراکنش

receipt_urlstring

لینک رسید برای تسویه های موفق

created_atstring

تاریخ و زمان شروع تراکنش

walletinteger

موجودی کیف پول بعد از تراکنش

resultstring

توضیحات تراکنش که از شرکت پرداخت برگشت داده می‌شود

descriptionstring

توضیحات تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است

factorNumberstring

شماره فاکتور تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است

mobilestring

شماره موبایل تراکنش که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است

callback_urlstring

آدرس بازگشتی که بعد از انجام تراکنش به آن صفحه بر‌می‌گردد که در مرحله ارسال اطلاعات و دریافت توکن ارسال شده است

form_titlestring

در صورت پرداخت از فرم پرداخت عنوان فرم نمایش داده می‌شود

settlementstring
portstring

پورت انجام تراکنش که در حال حاضر می تواند SAMAN و یا BEHPARDAKHT باشد

payerjson

اطلاعات پرداخت کننده تراکنش را مشخص‌ می‌کند

ipstring

ip پرداخت کننده در زمان پرداخت را مشخص می‌کند

namestring

نام پرداخت کننده را مشخص می‌کند

slugstring

درصورتی که تراکنش انتقال وجه داخلی باشد شناسه ونداری واریز کننده را نمایش می دهد

avatarstring

درصورتی که تراکنش انتقال وجه داخلی باشد عکس واریز کننده را نمایش می دهد

emailstring

ایمیل پرداخت کننده را مشخص می‌کند

phonestring

شماره تماس پرداخت کننده را مشخص می‌کند

addressstring

آدرس پرداخت کننده را مشخص می‌کند

mobilestring

شماره همراه پرداخت کننده را مشخص می‌کند

additional_fieldsjson

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

descriptionstring

توضیحات پرداخت کننده را مشخص می‌کند

receiverjson

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

namestring

نام صاحب حساب که تسویه به آن صورت گرفته است

slugstring

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

avatarstring

درصورتی که تراکنش انتقال وحه داخلی باشد عکس دریافت کننده مبلغ را نمایش می دهد

ibanstring

شماره شبا که تسویه به آن صورت گرفته است

bank_namestring

نام بانک شماره شبا که تسویه به آن صورت گرفته است

آیا این بخش مفید بود؟بلی خیر

var request = require('request')
var options = {
  method: 'GET',
  url: '/v3/business/:business/transaction',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer token',
    'Content-Type': 'application/json'
  }
}
request(options, function (error, response) {
  if (error) throw new Error(error)
  console.log(response.body)
})

{
    "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
                                },
    }
}

کسب و کار

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

آیا این بخش مفید بود؟بلی خیر
endpoints

GET /v2/business/:business

GET /v2/business/:business/iam

بازگشت وجه

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

شرایط لازم برای بازگشت وجه
  • فعال بودن ابزار بازگشت وجه
  • موفق بودن تراکنش
  • داشتن موجودی کافی در کیف‌ پول
آیا این بخش مفید بود؟بلی خیر
endpoints

POST /v3/business/:business/transaction/:transaction_id/refund