loader-img-2
loader-img-2
سنباد
سرویس دریافت Token(AC, CC)
سرویس Login Post

استفاده از این سرویس در این مرحله به منظور ایجاد Token مورد نظر جهت فراخوانی سرویس های AC است. در این مرحله ابتدا اطلاعات کلاینت به شکل زیر در پارامترها قرار گرفته و سرویس فراخوانی می‌شود. 



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



URL:https://api.sanbod.co/oautht/v1/authorize?traceid=123456

Body:

{ "provider_code": "059",
"redirect_uri": "https://google.com",
"scope": [
"statement"
],
"client_id": "test_sanbod",
"response_type": "code",
"state": 7000
}

مقادیر Body  می‌تواند با پارامترهای زیر پر شود:

Nullable Description Parameter
no کد بانک Provider_code
- Callback URL  application Redirect_uri
no سرویس های مجاز و قابل دسترس Scope
no شناسه مربوط به هر Application Client_id
no برابر با مقدار code قرار داده شود Response_type
- وضعیت State

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

جدول شماره 2

نام بانک Provider Code
پاسارگاد 057
پارسیان 054
سینا 059

برای تعیین scope در دریافت توکن روی سرویس‌های AC تستی بانک‌های مختلف می‌توانید از جدول زیر استفاده کنید: 

نام سرویس AC Service Scope
صورت حساب statement
انتقال وجه داخلی normaltransfer
انتقال وجه پایا achtransfer
گزارش پایا achreport
انتقال وجه ساتنا rtgstransfer
گزارش ساتنا rtgsreport

 پس از دریافت کد پاسخ 302 در Header Session لازم است تا آدرس ایجاد شده در location در browser مورد نظر وارد شود.




*توجه: برای داشتن Response صحیح برای سرویس بالا، لازم است تنظیمات Automatically follow redirects غیرفعال شود.

سپس در صفحه ی login مربوط به بانک مورد نظر اطلاعات ذیل وارد می‌شود.

توجه: برای اپلیکیشن تستی، user  و password برای provider code های مختلف یکسان است و طبق جدول وارد شود.

همچنین می‌توان هر کد ملی معتبری را به همراه user و password جدول زیر وارد کرد.

User_info
ela U sername
1234 Password
کدملی (معتبر) National code

 

کاربر به صفحه ی consent بانک مورد نظر به منظور تایید اطلاعات مربوط به سرویس‌ها، شماره سپرده‌ها و کارت‌ها منتقل می‌شود.

توجه: شماره حساب‌های تستی در سیستم وجود دارد و لازم به اضافه کردن آنها در جایی نیست.

شماره حساب های کاربر در بانک  (محیط تستی)
119-813-218257-4
119-813-218257-5

پس از وارد کردن اطلاعات و تایید صحت آنها کد تولید شده در Application callback URL در سرویس دریافت توکن (Get AC Token) مورد استفاده قرار می‌گیرد.

 

 

سرویس Get AC Token

احراز هویت در سرویس دریافت توکن بر اساس basic Authentication و با پارامترهای code و grant_type است. Code ای که در مرحله قبل دریافت شده است در این قسمت وارد می‌شود. در سرویس‌هایی از نوع AC مقدار grant_type بایستی برابر authorization_code باشد.

توجه: اطلاعات basic Authentication بایستی از طریق اطلاعات کلی مدیریت اپلکیشن از کنسول سنباد به آدرس console.sanbod.co اقدام کنید.

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

URL: https://api.sanbod.co/oautht/v1/authorize?traceid=123456

Body:

{
    "code": "bbe0ead3-3c2e-4551-95fa-8d3a93037ce6",
    "grant_type": "authorization_code"
}
سرویس Get CC Token

احراز هویت در سرویس دریافت توکن بر اساس basic Authentication و با پارامترهای scope و grant_type و provider_code است. در سرویس‌هایی از نوع CC مقدار grant_type بایستی برابر client_credentials باشد. همچنین، برای مقدار provider code ها هم از جدول شماره (2) استفاده شود. برای مقدار دهی scope‌های CC ازجدول زیر استفاده کنید:

نام سرویس CC Service Scope
استعلام شبا Ibaninquiry
تبدیل شماره کارت به شبا Cardtoiban
تبدیل شماره کارت به شماره حساب Cardtodeposit
تبدیل شماره حساب به شبا Deposittoiban
تبدیل شبا به شماره حساب Ibantodeposit

توجه: اطلاعات Basic Authentication بایستی از طریق اطلاعات کلی مدیریت اپلکیشن از کنسول سنباد به آدرس https://console.sanbod.co اقدام کنید.

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

URL: https://api.sanbod.co/oauth/v1/token?traceid=234567

Body:

{
    "grant_type": "client_credentials",
    "scope": [
        "ibaninquiry",
        "cardtoiban",
        "cardtodeposit",
        "deposittoiban",
        "ibantodeposit"
    ],
    "provider_code": "999"
}
سرویس Refresh-Token

این سرویس، بر اساس basic Authentication و با پارامترهای refresh_token (دریافت‌شده از سرویس tekon) و grant_type است. در سرویس Refresh Token مقدار grant_type بایستی برابر refresh_token باشد.

توجه: اطلاعات Basic Authentication بایستی از طریق اطلاعات کلی مدیریت اپلکیشن از آدرس اقدام کنید.

URL: https://api.sanbod.co/oauth/v1/token

Body:

{
    "grant_type": "refresh_token",
    "refresh_token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInR5cGUiOiJyZWZyZXNoIiwiZ3JhbnRfdHlwZSI6IkFDIiwiZW52aXJvbm1lbnQiOiJQUk9EVUNUSU9OIn0.eyJ1dWlkIjoiMjkzYWI5MTQ3YWYwNDQ1YTgzZGJkZGU0Nzg2ZmM2ZGYiLCJpYXQiOjE2NDM3ODY4MzcuMTUwMzI4LCJleHAiOjE2NzUzNDM3ODkuMTUwMzE4LCJwcml2YXRlIjoiZ0FBQUFBQmgtakpWckZ2VzM0VkpQVGt3dWNzUkF3bE5RT201eGxFdXFfbGZuRExpOElyekF5ekFZVnNtU1RPM3EwRjBmUHhoRll4emlDU1JqUVg0d25LYlE5V3E3dy0tR3c9PSIsInNjb3BlIjpbInN0YXRlbWVudCIsIm5vcm1hbHRyYW5zZmVyIl0sImFwcF9pZCI6MSwiZGVwb3NpdHMiOlsiMzAxMDA5Nzk5ODg2MDciXSwibGltaXRhdGlvbnMiOtODRlYS1jZjYyZDk1OWMzNWMiLCJjb25zZW50X3RyYWNraW5nX3V1aWQiOiI5ZTNlMjIyYS1hNDIyLTQyNTMtYmQxYy05NTYwNjVlNjBmMDIifQ.0ufh3UqvVXHVEqUd-BZIiXuS9O1srxe33fP4NupdsdY"
}

 

سرویس Revoke

این سرویس، بدون نیاز به Authentication و با پارامتر token (دریافت شده از سرویس tekon) است و تنها نیاز است، در قسمت Body مقدار access token جاری وارد شود.

URL: Api.sanbod.co/oauth/v1/revoke

Body:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsInR5cGUiOiJhY2Nlc3MiLCJncmFudF90eXBlIjoiQUMiLCJlbnZpcm9ubWVudCI6IlBST0RVQ1RJT04ifQ.eyJ1dWlkIjoiODZiNjRlNGQ2MjBkNDcwNTlkZGRjNDNkMjA3NWJjN2QiLCJpYXQiOjE2Mzk1Njk5NTAuMzU4MTksImV4cCI6MTYzOTU3MzU1MC4zNTgxNzcsInNIjcwMDAiLCJjYW5fZGlzcGxheV9zZXJ2aWNlcyI6dHJ1ZSwiYXBwbGljYXRpb25fbmFtZSI6ImNhc3BpYW4iLCJhcHBsaWNhdGlvbl9sb2dvIjoiL2ZpbGUvYzE4ZDY5YzEtOTNkOC00MjM0LTc2NDYtN2UwMGU5Y2MxMzExIiwidHJhY2VfaWQiOiJlNDNiMzAwNy1kMjE0LTQ3NTgtOTU2Yi04NDcxOTFhMmZjZDUiLCJjb25zZW50X3RyYWNraW5nX3V1aWQiOiJkZmQ1ODk1OS0zMTY2LTRiZTQtYTQ0Zi1lNjFiMTQxNGI3OTkifQ.yaHIXmrCLQMbLBzVHG-1yTbE60bo1ZeSiluEs12Bslg"
}
سرویس‌های انتقال وجه
انتقال وجه داخلی

POST / normaltransfer

با استفاده از  این سرویس می‌توانید از یک حساب در بانک مورد نظر به سایر حساب‌های همان بانک، واریز انجام دهید.

رویکرد: Authorization_Code


Headers


مقادیر زیر باید در هدر قرار بگیرد:

Content-Type: application/json
Authorization : Bearer {Token}

 

Query Parameters


نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانیِ انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body

{
 "destinationDepositNumber":"119-813-2295556-1",
 "sourceDepositNumber":"119-813-2618257-1",
 "transferAmount":"20000"
}
نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش‌فرض
sourceDepositNumber string بله شماره حساب مبداء    
destinationDepositNumber string بله شماره حساب مقصد    
transferAmount string بله مبلغ تراکنش    

Results Format

Successful result format
{
 "error": false,
 "message": {
 "docNumber": "00001632235711734468"
 },
 "result_number": 1,
 "traceid": 123
}
 
نام فیلد توضیحات
docNumber شماره تراکنش (مقدار آن برای هر بانک متفاوت است
result__number تعداد رکوردها
traceid کد پیگیری
انتقال وجه پایا

POST / achtransfer

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

انتقالات سامانه "پایا" برای دستورپرداخت‌های مشتریان صرفاً در روزهای کاری به شرح جدول زیر صورت می‌پذیرد:

ردیف چرخه تسویه  ساعت ثبت از    ساعت ثبت تا     ساعت ارسال
1 اول 13:15 03:15           03:45
2 دوم 03:15             10:15    10:45
3 سوم 10:15 13:15   13:45

 

رویکرد: Authorization_Code


 Headers


مقادیر زیر باید در هدر قرار بگیرد:

Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid     string بله جهت پیگیری فراخوانیِ انجام شده، می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body


}
 "sourceDepositNumber": "119-813-2618257-1",
 "iban": "IR410590011981302618257001",
 "transferAmount": "20000",
 "receiverFirstName": "سارا",
 "receiverLastName": "کاویانی",
 "description": "رستوران"
{ 
 
نام فیلد     نوع اجباری توضیحات مقادیر مجاز پیش‌فرض
sourceDepositNumber string بله شماره حساب مبداء    
iban string بله شماره شبای مقصد    
transferAmount integer بله مبلغ تراکنش    
receiverFirstName string بله نام صاحب حساب مقصد    
receiverLastName string بله نام خانوادگی صاحب حساب مقصد     
description string بله توضیحات    

Results Format

Successful result format
}
 "error": false,
 "message": {
 "referenceId": "140006310592000002",
 "iban": "IR410590011981302618257001",
 "transferAmount": "20000",
 "ownerName": "سارا کاویانی",
 "description": "رستوران",
 "transactionStatus": "ACCEPTED",
 "transferStatus": "READY_TO_TRANSFER"
 },
 "result_number": 1,
 "traceid”: 123
{
نام فیلد توضیحات
referenceId شماره ارجاع
iban شماره شبای مقصد
transferAmount مبلغ تراکنش
ownerName نام صاحب حساب مبداء
description توضیحات
transactionStatus وضعیت تراکنش
transferStatus وضعیت انتقال
traceid کد پیگیری
انتقال وجه ساتنا

POST / rtgstransfer


توضیحات سرویس: با استفاده از این سرویس درصورتی که مبلغ تراکنش بالاتر از 150 میلیون ریال باشد، می‌توانید از یک حساب در بانک مورد نظر به شماره حساب یا شبای سایر بانک‌ها، واریز انجام دهید.

رویکرد: Authorization_Code

Headers


مقادیر زیر باید در هدر قرار بگیرد:

Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری مقادیر مجاز
traceid string بله رشته و عدد

Body


{
 "sourceDepositNumber":"119-813-2618257-1",
 "destinationIban":"IR880540126030100979988607",
 "transferAmount":"160000000",
 "receiverLastName":"کاویانی",
 "receiverFirstName":"سارا",
 "description":"رستوران "
}
 
نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
sourceDepositNumber string بله شماره حساب مبداء    
destinationiban  string بله شماره شبای مقصد    
transferAmount integer بله مبلغ تراکنش    
receiverLastName string بله نام خانوادگی دارنده حساب    
receiverFirstName string بله نام کوچک صاحب حساب    
Description string بله توضیحات    

Results Format

Successful result format

{
 "error": false,
 "message": [
 {
 "referenceId": "00001631343145788607"
 }
 ],
 "result_number": 1,
 "traceid": 123

 
نام فیلد توضیحات
referenceId شماره ارجاع
Result_number تعداد رکوردها
traceid     کد پی
سرویس‌های گزارش‌گیری

https://api.kavenegar.com/v1/0/utils/getdate.json

 

{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries":
    {
        "datetime":"02/06/2012 01:53:46 ب.ظ",
        "year":2012,
        "month":1,
        "day":26,
        "hour":13,
        "minute":53,
        "second":46,
        "unixtime":1338645226
    }
}
 

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

 

صورت حساب

POST / statement


توضیحات سرویس: این سرویس لیست تراکنش‌های انجام شده روی یک حساب خاص را نمایش می‌دهد.

رویکرد: Authorization_Code

Headers


مقادیر زیر باید در هدر قرار بگیرد: 

Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانیِ انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body


{
 "depositNumber": "119-813-2618257-1",
 "length": 2,
 "offset": 0,
 "fromDateTime": 1641602238000,
 "toDateTime": 1645602238000,
 "order": "ASC"
}
نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
depositNumber string بله شماره حساب    
order string خیر ترتیب نمایش رکوردها (صعودی/نزولی)؛ در صورت خالی بودن، به صورت صعودی بر اساس تاریخ نمایش داده می‌شود. (این پارامترها برای برخی از بانک‌ها اعمال می‌شود.) ASC, DSC DSC
action string خیر نوع تراکنش؛ درصورت خالی بودن، هم بدهکار و هم بستانکار را نمایش می‌دهد. (این پارامترها برای برخی از بانک‌ها اعمال می‌شود.) CREDIT, DEBIT  
fromDateTime integer خیر تا تاریخ؛ درصورت خالی بودن، تراکنش‌های سه روز اخیر را نمایش می‌دهد. Unix Timestamp  
toDateTime integer خیر شماره اولین رکورد بازگشتی    
length integer خیر تعداد رکورد بازگشتی   25

Results Format

Successful result format


{
 "error": false,
 "message": [
 {
 "balance": "38566490",
 "transactionDate": 1645602238000,
 "description": "انتقال وجه اینترنت بانک به سپرده 119..1 ش.پ 00001632208206449023-مریم ایلخانی",
 "referenceId": "00001632208206449023",
 "docNumber": "10487401",
 "chequeNumber": "0",
 "transferAmount": "-20000.0" 
 ],
 "result_number": 1,
 "traceid": 123
}
نام فیلد توضیحات
balance موجودی
description شرح سند
referenceId شماره ارجاع
docNumber شماره پرونده
chequeNumber شماره چک
transferAmount مبلغ انتقال وجه
result_number تعداد رکوردها
traceid کد پیگیری
گزارش پایا

POST / achreport


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

رویکرد: Authorization_Code

Headers


مقادیر زیر باید در هدر قرار بگیرد:

Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانیِ انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد
{
 "depositNumber": "119-813-2618257-1",
 "__destinationIban": "IR410590011981302618257001", 
 "__destinationOwnerName": "مهدی هاشمی",
 "__factorNumber": "1",
 "__fromTransactionAmount": 1,
 "__toTransactionAmount": 2,
 "__referenceId": "1",
 "__fromIssueDateTime": 1553187438000,
 "__toIssueDateTime": 1653187438000,
 "__fromRegisterDateTime": 1553187438000,
 "__toRegisterDateTime": 1653187438000,
 "__length": 1,
 "__offset": 0
}

توجه: در صورت عدم ارسال پارامترهای از تاریخ انتقال/ثبت و "تاتاریخ انتقال/ ثبت"، تراکنش‌های سه روز اخیر را نمایش می‌دهد.

نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
depositNumber integer بله شماره حساب    
destinationIban string خیر شماره شبای مقصد    
offset integer خیر شماره اولین رکورد بازگشتی 0  
length integer خیر تعداد رکورد بازگشتی 25  
destinationOwnerName string خیر نام صاحب سپرده مقصد.(این پارامترها برای برخی از بانک‌ها اعمال می‌شود.)    
factorNumber string خیر شماره فاکتور را برمی‌گرداند. (این پارامترها برای برخی از بانک‌ها اعمال می‌شود.)    
fromTransactionAmount integer خیر حداقل مبلغ انتقال وجه پایا را مشخص می‌کند.    
toTransactionAmount integer خیر حداکثر مبلغ انتقال وجه پایا را مشخص می‌کند.    
referenceId string خیر شماره پیگیری انتقال وجه پایا . (این پارامترها برای برخی از بانک‌ها اعمال می‌شود.)    
fromIssueDateTime integer خیر از تاریخ انجام انتقال وجه پایا Unix Timestamp  
toIssueDateTime integer خیر تا  تاریخ انتقال وجه پایا Unix Timestamp  
fromRegisterDateTime integer خیر از حداقل تاریخ ثبت انتقال وجه پایا Unix Timestamp  
toRegisterDateTime integer خیر تا حداکثر تاریخ ثبت انتقال وجه پایا Unix Timestamp  

Results Format

Successful result format


{
 "error": false,
 "message": [
 {
 "referenceId": "140006310592000001",
 "registerDateTime": "1653187438000",
 "status": "PROCESSED",
 "transferDescription": null
 }
 ],
 "result_number": 1,
 "traceid": 123
}
نام فیلد توضیحات
referenceId شماره ارجاع
registerDateTime تاریخ ثبت انتقال وجه پایا را مشخص می‌کند
status وضعیت انتقال وجه پایا را برمی‌گرداند:
•    WAIT_FOR_CUSTOMER_ACCEPT : در انتظار تایید مشتری
•    WAIT_FOR_BRANCH_ACCEPT : در انتظار تایید شعبه
•    BRANCH_REJECT : رد شده از طرف شعبه
•    READY_TO_TRANSFER : آماده‌ی ارسال
•    SUSPEND : معلق
•    CANCEL : لغو شده
•    PROCESSED : انجام شده
transferDescription توضیحات تراکنش
result_number تعداد رکوردها
traceid کد پیگیری
گزارش ساتنا

POST / rtgsreport

توضیحات سرویس: این سرویس گزارش انتقال وجه‌های ساتنا را نمایش می‌دهد.

رویکرد: Authorization_Code

Headers


Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانی انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body


{
 "depositNumber": "119-813-2618257-1",
 "__docNumber": "9612200591000486",
 "__fromDateTime": 1553187438000,
 "__toDateTime": 1653187438000,
 "__offset": 0,
 "__length": 1
}

توجه: در صورت عدم ارسال پارامترهای از تاریخ  و "تا تاریخ" ، تراکنش‌های سه روز اخیر را نمایش می‌دهد.

نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
depositNumber integer بله شماره حساب    
docNumber string خیر شماره پیگیری تراکنش     
fromDateTime integer خیر از تاریخ Unix Timestamp  
toDateTime integer خیر تا تاریخ Unix Timestamp  
offset integer خیر شماره اولین رکورد بازگشتی   0
length integer خیر تعداد رکورد بازگشتی   25

  Results Format

Successful result format


{
 "error": false,
 "message": [
 {
 "transferAmount": "150000000",
 "destinationDepositNumber": "IR630560082680006040494001",
 "sourceDepositNumber": "IR410590011981302618257001",
 "registerDateTime": "1653187438000",
 "docNumber": "9612200591000486",
 "status": "TASFIYEH_SHODE"
 }
 ],
 "result_number": 1,
 "traceid": 123
}
نام فیلد توضیحات
transferAmount مبلغ تراکنش
destinationDepositNumber شماره حساب مقصد
sourceDepositNumber شماره حساب مبداء
registerDateTime تاریخ ثبت انتقال وجه
docNumber شماره پیگیری تراکنش
status وضعیت انتقال وجه پایا را برمی‌گرداند:
•    SABT_SHODE: ثبت شده
•    TAEED_SHOBE_SHODE : تایید شعبه شده
•    ADAM_TAEED_SHODE : عدم تایید شعبه
•    HAZF_SHODE : حذف شده
•    TAEED_SHOBE_SATNA : تایید شعبه ساتنا
•    ADAM_TAEED_SHOBE_SATNA : عدم تایید شعبه ساتنا
•    ERSAL_SHODE : ارسال شده
•    TASFIYEH_SHODEH: تسویه شده
•    TASFIYEH_NASHODE:تسویه نشده
result_number تعداد رکوردها
traceid کد پیگیری
سرویس‌های تبدیلی
تبدیل شماره حساب به شبا

POST / deposittoiban

توضیحات سرویس: با استفاده از این سرویس تبدیل شماره حساب به شماره شبا انجام می‌شود.

رویکرد: Client_Credential

Headers


مقادیر زیر باید در هدر قرار بگیرد:

Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانیِ انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body


مثال:

{
 "depositNumber": "213.8000.14707021.1",
 "provider":"057" 
}
نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
depositNumber string بله شماره حساب    
provider string بله کد بانک    

Results Format

Successful result format


{
 "error": false,
 "message": {
 "depositNumber": "119-813-2618257-4",
 "iban": "IR910540102220100630357602"
 },
 "result_number": 1,
 "trace_id": "c29db3bc-ae72-46c4-85a5-9606b8897c51"
}
نام فیلد توضیحات
depositNumber شماره حساب استعلام شده
iban شماره شبا
result_number تعداد رکوردها
traceid کد پیگیری
تبدیل شماره کارت به شبا

POST / cardtoiban

توضیحات سرویس: با استفاده از این سرویس تبدیل شماره کارت به شماره شبا انجام می‌شود.

رویکرد: Client_Credential

Headers


مقادیر زیر باید در هدر قرار بگیرد:

Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانی انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body:


مثال:

{
 "cardNumber": "IR660570021380014707021101"
}

 

نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
cardNumber string بله شماره کارت    

 

Results Format

Successful result format


{
 "error": false,
 "message": {
 "cardNumber": "5022291301984702",
 "iban": "IR660570021380014707021101"
 },
 "result_number": 1,
 "trace_id": "1813c00b-7b12-40ad-8b4f-f1ad53cd57b9"
}
نام فیلد توضیحات
cardNumber شماره کارت استعلام شده
iban شماره شبا
result_number تعداد رکوردها
traceid کد پیگیری
تبدیل شماره شبا به حساب

POST / ibantodeposit

توضیحات سرویس: با استفاده از این سرویس تبدیل شبا به شماره حساب انجام می‌شود.

رویکرد: Client_Credential

Headers


Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانیِ انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body:


مثال:

{
 "iban": " IR660570021380014707021101 "
}

 

نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
iban string بله شماره شبا    

 

Results Format

Successful result format


{
    "error": false,
    "message": {
        "depositNumber": "213.8000.14707021.1",
        "iban": "IR660570021380014707021101"
    },
    "result_number": 1,
    "trace_id": "807254e8-ad1c-4158-81b3-2ee5da38e70c"
}

نام فیلد توضیحات
depositNumber شماره حساب
iban شماره شبای استعلام شده
result_number تعداد رکوردها
traceid کد پیگیری
تبدیل شماره کارت به حساب

POST / cardtodeposit

توضیحات سرویس: با استفاده از این سرویس تبدیل شماره کارت به شماره حساب انجام می‌شود.

رویکرد: Client_Credential

Headers


Content-Type: application/json
Authorization : Bearer {Token}

Query Parameters


 
نام فیلد نوع اجباری توضیحات مقادیر مجاز
traceid string بله جهت پیگیری فراخوانیِ انجام شده می‌توانید از این پارامتر استفاده نمایید. رشته و عدد

Body:


مثال:

 

{
 "cardNumber": "IR660570021380014707021101"
}

 

نام فیلد نوع اجباری توضیحات مقادیر مجاز پیش فرض
cardNumber string بله شماره کارت    

 

Results Format

Successful result format


{
 "error": false,
 "message": {
 "cardNumber": "5022291301984702",
 "depositNumber": "213.8000.14707021.1"
 },
 "result_number": 1,
 "trace_id": "741353b9-5ee3-4644-b88d-676ed3c9553a"
}
نام فیلد توضیحات
cardNumber شماره کارت استعلام شده
depositNumber شماره حساب
result_number تعداد رکوردها
traceid کد پیگیری