سیستم استعلام API نرم افزار حسابداری آنلاین حسابفا

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

URL: https://api.hesabfa.com/v1/inquiry/credit

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

{
     apiKey: 'asdfASR^%FDHdsfg456',
     userId: 'mail@example.com',
     password: '123456',
     loginToken: 'f6b912...45fdc',
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن تعداد توکن باقیمانده درون Result قرار می گیرد.

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": 25 
}

استعلام کد ملی

URL: https://api.hesabfa.com/v1/inquiry/nationalIdentity

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*nationalCode	کد ملی
*birthDate	تاریخ تولد

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",  
	 "birthDate": "1999-01-01"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

Matched	مطابقت
FirstName	نام
LastName	نام خانوادگی
NationalCode	کد/شناسه ملی
IsDead	فوت شده
Alive	در قید حیات

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
			"FirstName": "حسن",
			"LastName": "حسنی",
			"NationalCode": "1234567890",
			"IsDead": false,   
			"Alive" : true  
	       }
    }
}

تطابق کد ملی و شماره موبایل

URL: https://api.hesabfa.com/v1/inquiry/checkMobileAndNationalCode

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*nationalCode	کد ملی
*mobile	شماره موبایل

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",  
	 "mobile": "09123456789"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

Matched مطابقت

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
	        	}
     }
}

تطابق شماره کارت و کد ملی

URL: https://api.hesabfa.com/v1/inquiry/checkCardAndNationalCode

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*nationalCode	کد ملی
*cardNumber	شماره کارت

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",  
	 "cardNumber": "6199999999999999"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

Matched مطابقت

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
			}
	  }
}

تطابق کدملی و شماره شبا

URL: https://api.hesabfa.com/v1/inquiry/checkIbanAndNationalCode

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*nationalCode	کد ملی
*birthDate	تاریخ تولد
*iban	شماره شبا

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "nationalCode": "1234567890",
	 "birthDate": "1999-01-01"	 
	 "iban": "IR910100010000001234567890"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

Matched مطابقت

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Matched": true,
			}
	  }
}

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

URL: https://api.hesabfa.com/v1/inquiry/iban

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*iban شماره شبا

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "iban": "IR910100010000001234567890"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

Name	نام و نام خانوادگی
BankName	نام بانک
IsTransferable	قابلیت انتقال وجه

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Name": "حسن حسنی",
			"BankName": "ملت",
			"IsTransferable": true
			}
	  }
}

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

URL: https://api.hesabfa.com/v1/inquiry/card

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*cardNumber شماره کارت

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "cardNumber": "6199999999999999"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

Name	نام و نام خانوادگی

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Name": "حسن حسنی",
			}
	  }
}

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

URL: https://api.hesabfa.com/v1/inquiry/cardToIban

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*cardNumber شماره کارت

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "cardNumber": "6199999999999999"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

IBAN	شماره شبا
BankName	نام بانک
Name	نام و نام خانوادگی

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"IBAN": "IR910100010000001234567890",
			"BankName": "ملت",
			"Name": "حسن حسنی"
			}
	  }
}

تبدیل شماره حساب به شماره شبا

URL: https://api.hesabfa.com/v1/inquiry/accountToIBAN

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*account	شماره حساب
*bank	کد بانک (جدول کد بانک )

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "account": "6199999999999999",
	 "bank": "012",
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

IBAN شماره شبا

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"IBAN": "IR910100010000001234567890",
			}
	  }
}

استعلام کد پستی

URL: https://api.hesabfa.com/v1/inquiry/postalCode

Request
Response

پارامترها:

apiKey
userId
password
loginToken پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)

*postalCode کد پستی

{
	 "apiKey": "asdfASR^%FDHdsfg456",
	 "loginToken": 'f6b912...45fdc',
	 "postalCode": "6199999999999999"
 }

آیتم های موجود در پاسخ:

Success
ErrorCode
ErrorMessage (مشاهده توضیحات)

Result در صورت موفقیت آمیز بودن Object بازگشتی درون Result قرار می گیرد.

Status	وضعیت
Message	پیام موفقیت یا خطا
Data

Address Object آدرس

Province	استان
Town	شهرستان
District	منطقه
Street	خیابان اصلی
Street2	خیابان فرعی
Number	پلاک
Floor	طبقه
SideFloor	واحد
BuildingName	نام ساختمان
Description	توضیحات

{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"Status": 1,
		"Message": "موفق",
		"Data": {
			"Address": {
				"Province": "استان تهران",
				"Town": " شهرستان تهران ",              
				"District": " محله 1",              
				"Street": " بلوار مدرس",              
				"Street2": " خیابان مدرس ",              
				"Number": "1",              
				"Floor": " طبقه همکف",              
				"SideFloor": "2", 
				"BuildingName": "ساختمان صدف",             
				"Description": "-"             
				}
			  }
	       }  
}

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

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

استعلام کد ملی

تطابق کد ملی و شماره موبایل

تطابق شماره کارت و کد ملی

تطابق کدملی و شماره شبا

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

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

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

تبدیل شماره حساب به شماره شبا

استعلام کد پستی