###GET /oak/v2/clients/{clientId}/deposits/{deposit}/statement * **شرح: ** &#x202b; با دریافت یک حساب و تاریخ به عنوان پارامتر،لیست تراکنش های بازه زمانی ارسال شده آن حساب را برمی‌گرداند.لازم به توضیح است که برای بانک‌های کشاورزی و خاورمیانه عمر توکن پانزده دقیقه می باشد و پس از آن منقضی می شود و نیاز است که توکن رفرش شود.از طرفی برای بانک کشاورزی حداکثر ۳۰ تراکنش آخر و برای بانک آینده حداکثر ۱۰۰ تراکنش آخر را داریم. * **اسکوپ: ** ```oak:statement:get``` * **رویکرد: ** ```Authorization_Code``` * **<a href="ResponseCodeOak.pdf"> دانلود مستندات ریسپانس کد ها</a> ** ```````````````` {address}/oak/v2/clients/{clientId}/deposits/{deposit}/statement?toDate={toDate}&fromDate={fromDate}&toTime={toTime}&fromTime={fromTime}&trackId={trackId} ```````````````` <div class="sandboxaddress sandbox" id="sandbox" style="float:right" style="display: none" > https://sandboxapi.finnotech.ir<b><span class="finnotech-sandbox-address-text"> :address </span></b> </div> <div class="production-address production" style="float:right" style="display: block"> https://apibeta.finnotech.ir <b> :address </b> </div> #### Headers مقادیر زیر باید در هدر قرار بگیرد ```````````````` Authorization : Bearer {Token} ```````````````` * برای فراخوانی این سرویس لازم است پس از دریافت اجازه ی دسترسی از کاربر، با توکن Authorization Code سرویس را فراخوانی نمایید. * **سرویس صورتحساب برای بانک کشاورزی برای بازه ی بیش از یک ماه پاسخگو نمیباشد** #### URI Parameters * **clientId :** شناسه کلاینت * **deposit :** شماره حساب معتبر، همان حسابی است که کاربر به آن اجازه داده و در پاسخ دریافت توکن به کلاینت برگردانده شده است. اگر حساب شما در بانکهای همکار شامل کاراکتر اضافه مانند خط تیره میباشد با همان فرمت در پارامتر استفاده کنید #### Query Parameters * **toDate:** &#x202b; فرمت تاریخ باید به صورت YYYYMMDD باشد . لازم به ذکر است بازه زمانی گردش حساب بیشتر از ۳۱ روز نمی تواند باشد و در صورت وارد کردن تاریخ شروع اعلام تاریخ پایان الزامی می باشد .اختیاری * **fromDate:** &#x202b; فرمت تاریخ باید به صورت YYYYMMDD باشد اختیاری * **fromTime:** &#x202b;فرمت زمان باید به صورت HHMMSS باشد اختیاری (این مورد برای کشاورزی و کارافرین قابل استفاده نیست) * **toTime:** &#x202b;فرمت زمان باید به صورت HHMMSS باشد اختیاری (این مورد برای بانک کشاورزی و کارافرین قابل استفاده نیست) * **lastRecordNumber:** &#x202b;در صورتی که در خروجی سرویس مقدار transactionChain برابر با M باشد به این معنی است که که در بازه زمانی انتخابی، بیشتر از 100 تراکنش وجود دارد و لذا برای دریافت 100 تراکنش بعدی مقدار lastRecordNumber در خروجی فراخوانی اول، در فراخوانی بعدی در پارامتر lastRecordNumber ارسال شود.(فقط برای بانک‌های آینده و خاورمیانه است) * **trackId:** اختیاری (string) &#x202b; کد پیگیری، رشته ای اختیاری با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. در صورت ارسال trackId، فراخوانی سرویس خود را با همین مقدار استعلام و پیگیری کنید. (در گزارش فراخوانی سرویس ها با همین رشته نتیجه را ببینید). در صورتیکه که این فیلد را ارسال نکنید یک رشته UUID برای این فراخوانی در نظر گرفته میشود و در پاسخ فراخوانی برگردانده میشود. * example: ```get-statement-960000918``` * **count:** (اختیاری - بانک پاسارگاد) تعداد تراکنش هایی که میخواهید نمایش داده شود ####Results Format ##### Successful result format (status code 200) ```````````````` { "trackId":"bf93588c-4f8c-401e-ad9c-1dc5dc6ed72f", "result":{ "iban":"IR000000000000000000000000", "branchCode":"0240", "branchName":"صادقیه", "accountCurrentBalance":"0000000000166895", "transactions":[ { "operationCode":{ "code":"722", "message":"حواله اينترنتي" }, "recordNumber":"001", "chequeNo": "", "balance":"0000000000166895", "balanceSign":"C", "optionalInformation30":" قاسم آینده", "optionalInformation15":"005100622124790", "optionalInformation":"005100622124790", "optionalInformation1":"قاسم ‌آینده", "transactionDescription":"722", "transactionAmountCredit":"0000000000000000", "transactionAmountDebit":"0000000000012000", "branchNo":"8000", "date":"000510", "fullDate":"14000510", "requestDate": "14000627", "time":"135454", "requestTime": "114415", "originKey":"000510135454KZ654661", "rawOriginKey":"14000510135454KZ654661", "userID":"KRZFINTS", "source":"02", "additionalInformation":"61| ربجنر|IR410120020000004499907416|121|000005100622124790|| | |ت|ت‌ قاسم آینده", "transactionClass":"IBAN", "ibanInformationMap":{ "branchCode":"", "bankCode":"", "reasonDescription":"ت", "transactionClass":"IBAN", "name":"ربجنر", "destinationIban":"IR000000000000000000000000", "chargeAmount":" قاسم ‌آینده", "payId":"121", "chakavakInfo":"", "transactionTypeCode":"61", "referenceId":"000005100622100000", }, "cardInformationMap":null, "ledgerInformationMap":null, "refCode": "", "transactionAmount": "100", "transactionFee": "", "transactionTeller": "", "transactionTypeList": "", "deposit": "", "destinationNumber": "", "transactionJournal": "", "transactionTerminalType": "", "transactionTerminalCode": "", "transactionBrTerminal": "", "chequeType": "", "transactionCycle": "", "blockAmount": "", "blockCode": "", "blockingReason": "", "chequeInformationMap": "", }, { "operationCode":{ "code":"001", "message":"نقدي" }, "recordNumber":"003", "chequeNo": "", "balance":"0000011110188895", "balanceSign":"C", "optionalInformation30":" قاسم ‌آینده", "optionalInformation15":"121", "optionalInformation":"121", "optionalInformation1":"‌آینده قاسم", "transactionDescription":"001", "transactionAmountCredit":"0000000000000000", "transactionAmountDebit":"0000000000010000", "branchNo":"8000", "date":"000510", "fullDate":"14000510", "requestDate": "14000627", "time":"134223", "requestTime": "114415", "originKey":"000510134223K0000000", "rawOriginKey":"140005101342230000000", "userID":"KRZFINUN", "source":"02", "additionalInformation":"", "transactionClass":null, "ibanInformationMap":null, "cardInformationMap":null, "ledgerInformationMap":null, "refCode": "", "transactionAmount": "100", } ], "lastRecordNumber":"99948986577685856751", "openDate":"13980703", "accountTypeCode":"040", "subTypeCode":"001", "customerName":"قاسم", "customerFamilyName": "ربجبر", "backupAccountNumber":"0000000000000", "accountCurrentBalanceSign":null, "accountAvailableBalance":"0000000000166895", "accountAvailableBalanceSign":"C", "effectiveAccountBalance":"", "effectiveAccountBalanceSign":"", "cicsTransId":"MB03", "seqNo":"1406", "dataType":"", "acknowledge":"O", "msgnbr":"", "availableSign":"", "averageBalance":"", "averageBalanceSign":"", "currentBalance":"0000000000166895", "currentBalanceSign":"C", "transactionChain":"L" } "status":"DONE" } ```````````````` * **result:** آبجکتی از پاسخ سرویس شامل: * **branchCode:** کد شعبه * **branchName:** نام شعبه * **accountTypeCode:** کد نوع حساب * **subTypeCode:** کد زیر نوع حساب * **iban:** شماره شبا * **customerName:** نام مشتری * **customerFamilyName:** نام خانوادگی مشتری * **backupAccountNumber:** شماره حساب حساب پشتیبان * **accountCurrentBalance:** مانده جاری * **accountCurrentBalanceSign:** علامت مانده جاری * **C: ** credit * **D: ** debit * **accountAvailableBalance:** مانده قابل برداشت * **accountAvailableBalanceSign:** علامت مانده قابل برداشت * **C: ** credit * **D: ** debit * **effectiveAccountBalance:** مانده موثر * **effectiveAccountBalanceSign:** علامت مانده موثر * **transactionChain:** مشخصه وجود تراکنش بیشتر * **M: ** وجود تراکنش بیشتر از 100 * **L: ** عدم وجود تراکنش بیشتر * **openDate:** &#x202b; تاریخ افتتاح حساب به صورت YYMMDD * **transactions:** آرایه ای از تراکنش ها با پارامتر های زیر * **recordNumber:** شماره ردیف * **balance:** مانده * **transactionAmountCredit:** مبلغ برای تراکنش های واریز * **transactionAmountDebit:** مبلغ برای تراکنش های برداشت * **transactionDescription:** شرح تراکنش * **branchNo:** کد شعبه * **date:** &#x202b; تاریخ که باید به صورت YYMMDD * **time:** &#x202b; باید به صورت HHMMSS * **operationCode:** نوع عملیات تراکنش * **code:** کد نوع عملیات تراکنش * **message:** شرح نوع عملیات تراکنش * **balanceSign:** علامت مانده * **optionalInformation30:** شرح ترکانش ۳۰ کاراکتری * **optionalInformation15:** شرح ترکانش ۱۵ کاراکتری * **optionalInformation1:** معادل شرح ترکانش ۳۰ کاراکتری * **optionalInformation:** معادل شرح ترکانش ۱۵ کاراکتری * **fullDate:** تاریخ * **requestDate:** تاریخ درخواست * **requestTime:** زمان درخواست * **originKey:** کد مرجع تراکنش * **rawOriginKey:** کد مرجع تراکنش (ویرایش نشده) * **additionalInformation:** اطلاعات اضافی تراکنش * **refCode:** (فقط برای بانک پاسارگاد)کد پیگیری * **transactionAmount:** (فقط برای بانک پاسارگاد)مبلغ تراکنش * **transactionClass:** طبقه بندی تراکنش * **IBAN** (ibanInformationMap) * **branchCode:** کد شعبه * **bankCode:** کد بانک * **transactionClass:** کلاس تراکنش * **name:** نام * **destinationIban:** شبای مقصد * **payId:** شناسه پرداخت * **chakavakInfo:** اطلاعات چکاوک * **transactionTypeCode:** کد نوع تراکنش * **paya:** 61 * **satna:** 62 * **atm:** 63 * **pin pad:** 03 * **pos:** 14 * **telebank:** 07 * **internet:** 59 * **mobile:** 05 * **info kiosk:** 13 * **info kiosk:** 43 * **ledger:** 02 * **referenceId:** کد رهگیری * **CARD** (cardInformationMap) * **branchCode:** کد شعبه * **bankCode:** کد بانک * **transactionClass:** کلاس تراکنش * **referenceNo:** شماره مرجع * **destinationPan:** شماره کارت مقصد * **sourcePan:** شماره کارت مبدا * **acquiringNo:** شماره پذیرنده * **transactionTypeCode:** کد نوع تراکنش * **deviceSerial:** سریال دستگاه * **trace:** شماره پیگیری * **billId:** شناسه قبض * **name:** نام * **destinationIban:** شبای مقصد * **payId:** شناسه پرداخت * **LEDGER** (ledgerInformationMap) * **transactionClass:** کلاس تراکنش * **transactionTypeCode:** کد نوع تراکنش * **payId:** شناسه پرداخت * **permissionId:** شماره مجوز * **reverseIndex:** شاخص تراکنش . صرفا برای برگشت حساب های کوتاه مدت * **reverseOriginKey:** کلید تراکنش . صرفا برای برگشت حساب های کوتاه مدت * **reasonDescription:** شرح <!-- * **cicsTransId:**--> <!-- * **seqNo:**--> <!-- * **dataType:**--> <!-- * **acknowledge:**--> <!-- * **msgnbr:**--> * **availableSign:** علامت مانده در دسترس * **averageBalance:** میانگین مانده در بازه تراکنش * **averageBalanceSign:** علامت میانگین مانده * **currentBalance:** مانده جاری * **currentBalanceSign:** علامت مانده جاری * **transactionFee:** (فقط برای بانک کشاورزی) * **transactionTeller:** (فقط برای بانک کشاورزی) * **transactionTypeList:** (فقط برای بانک کشاورزی) * **deposit:** (فقط برای بانک کشاورزی) * **destinationNumber:** (فقط برای بانک کشاورزی) * **transactionJournal:** (فقط برای بانک کشاورزی) * **transactionTerminalType:** (فقط برای بانک کشاورزی) * **transactionTerminalCode:** (فقط برای بانک کشاورزی) * **transactionBrTerminal:** (فقط برای بانک کشاورزی) * **chequeType:** (فقط برای بانک کشاورزی) * **transactionCycle:** (فقط برای بانک کشاورزی) * **blockAmount:** (فقط برای بانک کشاورزی) * **blockCode:** (فقط برای بانک کشاورزی) * **blockingReason:** (فقط برای بانک کشاورزی) * **chequeInformationMap:** (فقط برای بانک کشاورزی) * **trackId: **‌ کد پیگیری، اگر ارسال شده باشد همان مقدار و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود * **status: ** وضعیت فراخوانی سرویس * DONE: فراخوانی موفق سرویس * FAILED: فراخوانی ناموفق سرویس * **error:** جزییات خطا (در صورت بروز خطا) #### UnSuccessful result format در اینجا میتوانید لیست خطاهای سرویس ها را مشاهده کنید [لیست خطاها](/doc/generic-errors.html)