انتقال وجه گروهی کارتابلی
خدمتدهنده
بازارچه پادیوم
مقدمه
انتقال وجه گروهی به نوعی از انتقال وجه گفته میشود که در آن به کمک یکی از روشهای ساتنا، پایا، واریز به حساب دیجیتال و واریز به کارت عمل انتقال از یک حساب به چندین حساب به صورت یکجا صورت میپذیرد. این روش انتقال وجه میتواند به کمک بسیاری از شرکتها و پلتفرمها در مدیریت مالی بیاید. در مجموعه سرویس انتقال وجه گروهی کارتابلی، ویژگی کارتابلی بودن هم به انتقال وجه گروهی اضافه شده است. به این صورت که درخواستدهنده یک حساب چند امضایی ایجاد و برای افراد ذینفع نقش تعیین میکند. سپس برای هر بار انتقال وجه گروهی، نیاز به تایید هر کدام از افراد ذینفع خواهد بود. تعیین نقش افراد توسط شعبهی بانک صورت میپذیرد.
پیش از شروع
- URL فراخوانی سرویسها:
Production Server: https://api.pod.ir/srv/sc/nzh/doServiceCall
Sandbox Server:https://sandbox.pod.ir/srv/sc/nzh/doServiceCall
- تمامی درخواستها با متد POST ارسال میشوند.
- فیلدهای زیر درHeader تمامی درخواستها ثابت است:
پارامتر | توضیحات |
_token_ | توکن کسبوکاری دریافتی از پنل |
_token_issuer_ | مقدار ثابت "1" |
- فیلدهای زیر در بدنهی تمامی درخواستها ثابت است (با فرمت x-www-form-urlencoded):
پارامتر | توضیحات |
scProductId | شناسهی سرویس مدنظر |
scApiKey | راهنمای دریافت این پارامتر در این لینک موجود است. |
- علاوه بر موارد بالا که ثابت هستند، اگر سرویس نیاز به پارامتر دیگری داشته باشد در داکیومنت مربوطه ذکر شده است.
- خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.
نکته: پس از درخواست سرویس به پادیوم، همکاران ما درخواستهای ارسالی را بررسی میکنند. در صورت عدم دریافت تایید کرد بر روی درخواست ارسالی ظرف یک روز کاری،به همکاران ما از طریق شماره تلفن (021-89518989) و یا در گروه واتساپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.
ثبت درخواست انتقال وجه گروهی کارتابلیشماره سرویس: 3585512 (سندباکس : 164970) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
امکان انجام عملیات مالی (تسویه) به صورت گروهی توسط کسب وکار در بستر حساب های چند امضایی فراهم شده است. کاربران درخواست دهنده امکان وارد کردن ، رکوردهای تراکنش به صورت یک JSON Array را در قالب یک درخواست خواهند داشت . و تایید کنندگان نیز امکان دریافت فایل (دانلود) و تایید/عدم تایید آن درخواست را به صورت گروهی خواهند داشت. لازم بذکر است: درخواست تراکنش های گروهی بر اساس نوع حساب چند امضایی ارسال و بررسی خواهند شد. نقش درخواست دهندگان مطابق با زمان ایجاد حساب چند امضایی توسط شعبه ی بانک خواهد بود. نقش تاییدکنندگان و قوانین تایید نیز مطابق با زمان ایجاد حساب چند امضایی توسط شعبه ی بانک می باشد. در صورت تایید/عدم تایید درخواست تراکنش گروهی توسط تاییدکنندگان، کل محتوای فایل ارسالی تایید یا رد خواهند شد. در صورتیکه هر کدام از تراکنش ها به صورت فردی، به هر علتی با خطا مواجه شوند، همان تراکنش انجام نشده ولی باقی تراکنش های داخل فایل ارسالی، روند خود را طی خواهند کرد. در واقع عدم انجام یک یا چند تراکنش در دسته ی تراکنش ها، تاثیری بر روی باقی تراکنش ها نخواهد گذاشت. پس از ایجاد حساب چند امضایی توسط شعبه ی بانک (ادمین سیستم)، برای ایجاد امکان ثبت درخواست تراکنش گروهی در کارتابل، سرویس زیر را صدا بزنید: پارامتر totalAmount ، مجموع مبلغ کل رکوردهای ارسالی در فایل گروهی می باشد.( که در این نسخه از سرویس، توسط سرویس محاسبه میشود ) پارامتر cartableId به صورت اجباری می باشد که در واقع شناسه حساب چند امضایی ای است که درخواست انجام تراکنش گروهی بر بستر آن حساب را دارید. براساس اینکه نحوه ی تایید درخواست کارتابل را به چه شکلی تعیین کرده باشید : (API یا پیامک ) کد تاییدی به تایید کنندگان ارسال میشود : اگر به صورت پیامک بوده باشد ، بعد از ارسال درخواست ( فراخوانی سرویس زیر ) یک پیامک حاوی متن زیر به تایید کنندگان ارسال میشود : *سرزمین هوشمند پاد* درخواست عملیات مالی مربوط به درخواست برداشت اعتبار با مبلغ کل: 4000 در انتظار تایید شماست؛ لطفا جهت تایید کد 4001031 را به همین شماره ارسال و یااز طریق پنل اقدام نمایید . اگر تایید را براساس API انتخاب کرده باشید ، باید از طریق API برای تایید تراکنش اقدام نمایید .
firstName = نام صاحب شبا/کارت مقصد toolCode = روش انتقال وجه که پایا / ساتنا / کارت می باشد lastName= نام خانوادگی صاحب شبا /کارت مقصد amount = مبلغ انتقال ( ریال ) toolId = شناسه کارت یا شبا ( براساس مقدار وارد شده در فیلد toolCode ) دقت شود که برای شماره شبا نباید IR وارد شود. uniqueId = شناسه یکتای تراکنش که توسط کسب وکار ایجاد و ارسال میشود . currencyCode = مقدار ثابت IRR برای پارامتر toolCode میتوان از مقادیر زیر استفاده کرد : انتقال پایا : SETTLEMENT_TOOL_PAYA انتقال ساتنا : SETTLEMENT_TOOL_SATNA انتقال کارت : SETTLEMENT_TOOL_CARD | |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 3585512 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
یک لیست حاوی تراکنشهای انتقال وجه : json
| JSON Array [{},{}] | list | |
شناسه حساب کارتابل : که بعد از اعلام درخواست اولیه جهت فعالسازی از پادیوم دریافت می نمایید |
| cartableId | |
شناسه یکتای درخواست کارتابلی : هر درخواست باید یک شناسه مجزا باشد. |
| cartableUniqueId | |
شرح درخواست کارتابلی |
| requestDescription | |
فیلدهای رکورد انتقال در پارامتر list | |||
نام ، شخصی که مبلغ به شبای وی واریز میشود |
| firstName | |
نام خانوادگی ، شخصی که مبلغ به شبای وی واریز میشود |
| lastName | |
نوع عملیات - که باید یکی از مقادیر ثابت زیر باشد : انتقال پایا : SETTLEMENT_TOOL_PAYA انتقال ساتنا : SETTLEMENT_TOOL_SATNA انتقال کارت : SETTLEMENT_TOOL_CARD |
| toolCode | |
شناسه ی یکتای هر رکورد |
| uniqueId | |
براساس نوع toolCode انتخابی ، برای کارت باید شماره کارت ، و برای ساتنا و پایا ، شماره شبا (بدون IR)وارد شود |
| toolId | |
مبلغ تراکنش |
| amount | |
نوع وجه انتقالی : IRR |
| currencyCode | |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس ثبت درخواست | string | result.result.result | |
شناسه درخواست انتقال وجه گروهی کارتابلی |
| id | |
وضعیت فعلی درخواست کارتابلی : در انتظار تایید CARTABLE_REQUEST_WAITING,
تایید کامل شد CARTABLE_REQUEST_CONFIRMED,
پردازش فایل جهت انجام انتقال شروع شد CARTABLE_REQUEST_FILE_PROCESS_START
پردازش فایل درخواست کامل شد CARTABLE_REQUEST_FINALIZED,
CARTABLE_REQUEST_CANCELED, CARTABLE_REQUEST_REJECTED, CARTABLE_REQUEST_FAILED, CARTABLE_REQUEST_EXPIRED |
| statusCode | |
نمونه درخواست: | |||
javascript
| |||
نمونه پاسخ: | |||
json
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است | ||
999 | خطای داخلی سرویس های پاد | ||
تایید درخواست کارتابلشناسه سرویس : 2775884 (سندباکس : 160493) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
confirmRequest دریافت تایید در عملیات برداشت از حساب چند امضایی از طریق پیامک و از طریق وب سرویس انجام میپذیرد که استفاده از این دو روش در هنگام ایجاد یک حساب چند امضایی تعیین میشود. همچنین کاربر از طریق وب سرویس و یا ارسال پاسخ در پیامک، تایید و یا رد درخواست را اعلام میکند. پس از تایید یک سطح از کاربران، کاربران سطح بعدی از طریق پیامک از وجود تراکنش مربوطه مطلع میشوند. در صورتی که در شروط تعریف شده برای یک نوع از تراکنش، چند نفر به عنوان تاییدکننده وجود داشته باشند با رد درخواست توسط هریک از نفرات، درخواست تایید نخواهد شد. ضمن آنکه در شرایط موازی، یعنی تایید یک نفر از چند نفر به منزله تایید خواهد بود؛ اولویت سیستم با اولین نفری است که درخواست را تایید و یا رد کرده باشد.
توجه داشته باشید ، برای استفاده از این سرویس باید کاربر موردنظر را ابتدا در پاد لاگین کرده ، و AccessToken کاربر را به منظور استفاده در پارامتر _token_ این سرویس دریافت کرده باشید.
| |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 2775884 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
شناسه درخواست
|
| id | |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس | string | result.result | |
نمونه درخواست | |||
javascript
| |||
نمونه پاسخ | |||
json
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است |
رد درخواست کارتابلشناسه سرویس : 2775885 ( سندباکس : 160494 ) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
rejectRequest
هر کاربر تاییدکننده که یک درخواست را حساب کاربری خود مشاهده میکند، میتواند آن را تایید و یا رد کند. این سرویس این امکان را مهیا میکند تا رد درخواست (در صورت لزوم همراه را ارائه توضیحات) صورت پذیرد. در صورتی که یک درخواست رد شود، سایر افراد مرتبط به آن تراکنش چند امضایی میتوانند این موضوع را مشاهده کنند تا در صورت لزوم درخواست جدید دیگری ثبت نمایند
توجه داشته باشید ، برای استفاده از این سرویس باید کاربر موردنظر را ابتدا در پاد لاگین کرده ، و AccessToken کاربر را به منظور استفاده در پارامتر _token_ این سرویس دریافت کرده باشید. | |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 2775885 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
شناسه درخواست |
| id | |
توضیحات |
| description | |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس | string | result.result | |
نمونه درخواست | |||
json
| |||
نمونه پاسخ | |||
json
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است |
لغو درخواست کارتابلشناسه سرویس : 2775886 (سندباکس : 160495) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
cancelRequest هر یک از کاربران تعریف شده در یک حساب چند امضایی (شامل هر یک از حالتهای مختلف تعریف شده بنا به نوع تراکنش و سطح مالی)، شامل درخواست دهنده و تاییدکنندگان میتوانند حتی پس از تایید اولیه خود و قبل از رسیدن به کفایت امضا نسبت به لغو آن درخواست اقدام کنند. درخواستهایی که در صف انتظار موجودی هستند لغو نمیشوند و همچنین در صورتی که درخواستها 10 روز پس از ثبت، تایید یا رد نشده باشند، یه صورت خودکار توسط سیستم لغو میشوند. در صورتی که یک درخواست لغو شود، سایر افراد مرتبط به آن تراکنش میتوانند از این موضوع مطلع شوند تا در صورت لزوم درخواست جدید دیگری ثبت نمایند. توجه داشته باشید ، برای استفاده از این سرویس باید کاربر موردنظر را ابتدا در پاد لاگین کرده ، و AccessToken کاربر را به منظور استفاده در پارامتر _token_ این سرویس دریافت کرده باشید.
| |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 2775886 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
شناسه درخواست |
| id | |
توضیحات |
| description | |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس | string | result.result | |
نمونه درخواست | |||
javascript | |||
نمونه پاسخ | |||
json | |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است | ||
دریافت لیست درخواست های کارتابل برای کسب وکارشناسه سرویس : 2775904 (سندباکس : 160519) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
biz/getCartableRequest آنجایی که هر کاربر و یا کسب وکار به اطلاعاتی در خصوص حسابهای چند امضایی موجود و مرتبط با خودش نیاز دارد، سرویسهایی ارائه شده است تا آنها قادر به دریافت اطلاعات حسابهای چند امضایی خودشان مطابق پارامترهای تعریف شده باشند؛ شامل اینکه چه حساب های دارند، در چه حسابهای تایید کننده هستند، در چه حسابهایی امکان تعریف درخواست دارند و | |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 2775904 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
الزامی – شروع لیست |
| offset | |
الزامی – اندازه لسیت |
| size | |
شناسه حساب چندامضایی - شناسه کارتابل |
| cartableId | |
شناسه یکتا درخواست چندامضایی |
| requestId | |
شناسه کاربر درخواست دهنده |
| requesterUserIds | |
شناسه کاربر/ کاربران تایید کننده |
| confirmerUserIds | |
کد نوع تراکنش MULTI_CONFIRMATION_TYPE_INVOICE, MULTI_CONFIRMATION_TYPE_DELEGATION_RULE, MULTI_CONFIRMATION_TYPE_AMOUNT_VOUCHER, MULTI_CONFIRMATION_TYPE_PERCENT_VOUCHER, MULTI_CONFIRMATION_TYPE_TRANSFER, MULTI_CONFIRMATION_TYPE_SETTLEMENT, MULTI_CONFIRMATION_TYPE_VOUCHER |
| requestTypeCode | |
کد وضعیت درخواست CARTABLE_REQUEST_WAITING, CARTABLE_REQUEST_CONFIRMED, CARTABLE_REQUEST_FINALIZED, CARTABLE_REQUEST_CANCELED, CARTABLE_REQUEST_REJECTED, CARTABLE_REQUEST_FAILED, CARTABLE_REQUEST_EXPIRED |
| status | |
شناسه کاربر در انتظار تایید درخواست |
| pendingUserId | |
|
|
| |
توضیحات درخواست |
| description | |
از تاریخ شمسی yyyy/mm/dd |
| fromDate | |
تا تاریخ شمسی yyyy/mm/dd |
| toDate | |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس | string | result.result | |
تعداد کامل درخواستهای کارتابل برای کسب وکار که با استفاده از این فیلد و فیلدهای offset, size میتوان بر روی تمامی لیست درخواست پیمایش انجام داد. |
| count | |
نمونه درخواست | |||
javascript
| |||
نمونه پاسخ | |||
json
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است |
دریافت لیست درخواست های کارتابل برای کاربر تایید کنندهشناسه سرویس : 2775905 (سندباکس : 160520) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
getCartableRequest در این سرویس کلیه اطلاعات مربوط به یک تراکنش چند امضایی مطابق با پارامترهای زیر توسط کاربر قابل دستیابی است. دقت شود میتونید از سرویس 2775906 نیز استفاده نمایید. توجه داشته باشید ، برای استفاده از این سرویس باید کاربر موردنظر را ابتدا در پاد لاگین کرده ، و AccessToken کاربر را به منظور استفاده در پارامتر _token_ این سرویس دریافت کرده باشید.
| |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 2775905 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
الزامی – شروع لیست |
| offset | |
الزامی – اندازه لسیت |
| size | |
شناسه حساب چندامضایی - شناسه کارتابل |
| cartableId | |
شناسه یکتا درخواست چندامضایی |
| requestId | |
شناسه کاربر درخواست دهنده |
| requesterUserIds | |
شناسه کاربر/ کاربران تایید کننده |
| confirmerUserIds | |
کد نوع تراکنش MULTI_CONFIRMATION_TYPE_INVOICE, MULTI_CONFIRMATION_TYPE_DELEGATION_RULE, MULTI_CONFIRMATION_TYPE_AMOUNT_VOUCHER, MULTI_CONFIRMATION_TYPE_PERCENT_VOUCHER, MULTI_CONFIRMATION_TYPE_TRANSFER, MULTI_CONFIRMATION_TYPE_SETTLEMENT, MULTI_CONFIRMATION_TYPE_VOUCHER |
| requestTypeCode | |
کد وضعیت درخواست CARTABLE_REQUEST_WAITING, CARTABLE_REQUEST_CONFIRMED, CARTABLE_REQUEST_FINALIZED, CARTABLE_REQUEST_CANCELED, CARTABLE_REQUEST_REJECTED, CARTABLE_REQUEST_FAILED, CARTABLE_REQUEST_EXPIRED |
| status | |
شناسه کاربر در انتظار تایید درخواست |
| pendingUserId | |
توضیحات درخواست |
| description | |
از تاریخ شمسی yyyy/mm/dd |
| fromDate | |
تا تاریخ شمسی yyyy/mm/dd |
| toDate | |
|
|
| |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس | string | result.result | |
تعداد کامل درخواستهای کارتابل برای کسب وکار که با استفاده از این فیلد و فیلدهای offset, size میتوان بر روی تمامی لیست درخواست پیمایش انجام داد. |
| count | |
نمونه درخواست | |||
javascript
| |||
نمونه پاسخ | |||
json
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است |
دریافت لیست درخواست های کارتابل برای درخواست دهنده یا تایید کنندهشناسه سرویس: 2775906 (سندباکس: 160521) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
getCartableRequestForRequesterOrConfirmer در این سرویس کلیه اطلاعات مربوط به یک تراکنش چند امضایی مطابق با پارامترهای زیر توسط کاربرهای ایجاد کننده و تایید کننده تراکنش قابل دستیابی است. توجه داشته باشید ، برای استفاده از این سرویس باید کاربر موردنظر را ابتدا در پاد لاگین کرده ، و AccessToken کاربر را به منظور استفاده در پارامتر _token_ این سرویس دریافت کرده باشید. | |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 2775906 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
الزامی – شروع لیست |
| offset | |
الزامی – اندازه لسیت |
| size | |
شناسه حساب چندامضایی - شناسه کارتابل |
| cartableId | |
شناسه کاربر |
| userId | |
شناسه کسب وکار |
| businessId | |
شناسه یکتا درخواست چندامضایی |
| requestId | |
کد نوع تراکنش MULTI_CONFIRMATION_TYPE_INVOICE, MULTI_CONFIRMATION_TYPE_DELEGATION_RULE, MULTI_CONFIRMATION_TYPE_AMOUNT_VOUCHER, MULTI_CONFIRMATION_TYPE_PERCENT_VOUCHER, MULTI_CONFIRMATION_TYPE_TRANSFER, MULTI_CONFIRMATION_TYPE_SETTLEMENT, MULTI_CONFIRMATION_TYPE_VOUCHER |
| requestTypeCode | |
کد وضعیت درخواست CARTABLE_REQUEST_WAITING, CARTABLE_REQUEST_CONFIRMED, CARTABLE_REQUEST_FINALIZED, CARTABLE_REQUEST_CANCELED, CARTABLE_REQUEST_REJECTED, CARTABLE_REQUEST_FAILED, CARTABLE_REQUEST_EXPIRED |
| status | |
شناسه کاربر در انتظار تایید درخواست |
| pendingUserId | |
کد یکتای درخواست |
| uniqueId | |
توضیحات درخواست |
| description | |
از تاریخ شمسی yyyy/mm/dd |
| fromDate | |
تا تاریخ شمسی yyyy/mm/dd |
| toDate | |
|
|
| |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس | string | result.result | |
تعداد کامل درخواستهای کارتابل برای کسب وکار که با استفاده از این فیلد و فیلدهای offset, size میتوان بر روی تمامی لیست درخواست پیمایش انجام داد. |
| count | |
نمونه درخواست | |||
javascript
| |||
نمونه پاسخ | |||
java
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است |
دانلود فایل درخواست ثبت شدهشناسه سرویس: 3616806 (سندباکس: 164967) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
بعد از ارسال درخواست گروهی ، یک فایل حاوی رکوردهای ارسالی ، ایجاد می شود و آن فایل به منظور انجام عملیات پردازش میشود . در خروجی سرویس (ثبت یا استعلام ) درخواست کارتابلی ، اطلاعات این فایل در فیلد requestFile قرار دارد ، که میتوانید برای دانلود توسط این سرویس از آن استفاده نمایید . name : نام فایل تولید شده ترکیبی از شناسه کاربری درخواست دهنده ، و شناسه یکتای درخواست کارتابلی در ورودی سرویس 3585512 است .
"requestFile": { "id": 4142462, // file Id "name": "179734-1454650.csv", // file Name "hashCode": "184190c47f7-0.064002053", // Hash code "size": 0 },
firstName,lastName, toolCode, toolId, amount, currencyCode, uniqueId, توجه نمایید که تایید یا رد درخواست به صورت گروهی برای تراکنشها اعمال میشود. | |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار و (یا اکسس توکن کاربر ) ، که از پنل کسب وکار یا (فرایند لاگین کاربر ) قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند و در این سرویس باید مقدار multipart/form-data باشد . | multipart/form-data | Content-Type | |
Params | |||
| 3616806 | scProductId | |
|
| scApiKey | |
شناسه فایل |
| fileId | |
کد هش فایل آپلود شده |
| hashCode | |
خروجی | |||
json
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است | ||
999 | خطای داخلی سرویس های پاد |
دانلود فایل نتیجهشناسه سرویس: 3616806 (سندباکس : 164967) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
بعد از ثبت درخواست گروهی ، و پایان یافتن پردازش درخواست ، و وارد شدن آن درخواست به وضعیت FINALIZED . میتوانید فایل نتیجه را که در اطلاعات آن در خروجی سرویس استعلام درخواست در فیلد resultFile قرار دارد را دانلود نموده و براساس آن تصمیم گیری نمایید. "resultFile": { "id": 4142463, // file id "name": "result-15622.csv", // file name "hashCode": "1841911127e-0.62628112", // Hash code "size": 0 }
این فایل در قالب CSV و دارای سرآیندهای زیر می باشد : "firstName,lastName, toolCode, toolId, amount, currencyCode, uniqueId, success, message
وضعیت success در صورت موفق بودن ثبت تراکنش در صف پایا برابر با TRUE خواهد بود. اگر دارای مقدار FALSE باشد ، آن تک تراکنش را باید مجدد تکرار نمایید .
توجه نمایید که تایید یا رد درخواست به صورت گروهی برای تراکنشها اعمال میشود. | |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار و (یا اکسس توکن کاربر ) ، که از پنل کسب وکار یا (فرایند لاگین کاربر ) قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند و در این سرویس باید مقدار multipart/form-data باشد . | multipart/form-data | Content-Type | |
Params | |||
| 3616806 | scProductId | |
|
| scApiKey | |
شناسه فایل |
| fileId | |
کد هش فایل آپلود شده |
| hashCode | |
خروجی | |||
java
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است | ||
999 | خطای داخلی سرویس های پاد |
استعلام تراکنش تسویهشناسه سرویس: 29989 (سندباکس : 39375) نشانی سندباکس https://sandbox.pod.ir/srv/sc/nzh/doServiceCall | |||
دریافت لیست درخواست های برداشت وجه مشتری - گزارش وضعیت تسویه : هر رکورد ورودی در لیست ثبت درخواست ، در نهایت تبدیل به یک تراکنش تسویه از حساب خواهد شد ، که میتوانید وضعیت آن تک تراکنش را یا ، وضعیت لیست تسویه ها را از این سرویس استفاده نمایید.
settlementLogSrvs در این فیلد خروجی میتوانید لاگ عملیات انجام شده را مشاهده نمایید .
status در این فیلد خروجی میتوانید وضعیت تراکنش رامشاهده نمایید "status": "SETTLEMENT_DONE", وضعیت نهایی و مبلغ مورد نظر واریز شده است. | |||
توضیحات | مقدار | نام پارامتر | |
ورودی | |||
Header | |||
توکن ثابت کسب وکار، که از پنل کسب وکار قابل دریافت است | yourBusinessToken | _token_ | |
این پارامتر همواره دارای مقدار ثابت 1 است . | 1 | _token_issuer_ | |
این پارامتر نوع داده ارسالی به سرور را مشخص میکند که همواره باید دارای مقدار ثابت application/x-www-form-urlencoded' باشد | application/x-www-form-urlencoded | Content-Type | |
Body | |||
شناسه سرویس | 29989 | scProductId | |
کلید فراخوانی سرویس |
| scApiKey | |
الزامی – شروع لیست |
| offset | |
الزامی – اندازه لسیت |
| size | |
شناسه تراکنش ارسالی |
| uniqueId | |
شناسه درخواست تسویه تولید شده در سرویس تسویه |
| id | |
کد وضعیت درخواست تسویه : SETTLEMENT_REQUESTED, SETTLEMENT_SENT, SETTLEMENT_DONE |
| statusCode | |
شماره شبا ، کارت مورد استفاده به عنوان مقصد تسویه |
| toolId | |
نوع ابزار استفاده شده برای تسویه : کارت به کارت،پایا،ساتنا SETTLEMENT_TOOL_SATNA SETTLEMENT_TOOL_PAYA SETTLEMENT_TOOL_CARD |
| toolCode | |
کد ارز Default value : IRR |
| currencyCode | |
مبلغ |
| fromAmount | |
مبلغ |
| toAmount | |
حد پایین تاریخ درخواست شمسی yyyy/mm/dd |
| fromDate | |
حد بالای تاریخ درخواست شمسی yyyy/mm/dd |
| toDate | |
مشخصات نام |
| firstName | |
مشخصات نام |
| lastName | |
شماره فاکتور |
| invoiceId | |
شناسه پرداخت |
| paymentId | |
خروجی | |||
در صورت وقوع خطا در فراخوانی سرویس true خواهد بود | true/false | hasError | |
جهت بررسی لاگ درخواست و ریسپانس توسط کارشناسان پادیوم ، استفاده میشود. توصیه می شود این پارامتر را برای هر درخواست ذخیره کنید. | string | referenceNumber | |
نتیجه ی نهایی سرویس | string | result.result | |
تعداد کامل درخواستهای کارتابل برای کسب وکار که با استفاده از این فیلد و فیلدهای offset, size میتوان بر روی تمامی لیست درخواست پیمایش انجام داد. |
| count | |
نمونه درخواست | |||
javascript
| |||
نمونه پاسخ | |||
json
| |||
خطاهای معمول در پلتفرم | |||
کد خطا | توضیح | ||
21 | توکن کسبوکاری وارد نشده است | ||
227 | تایم اوت سرویس اصلی | ||
378 | ارسال پاسخ از سرویس اصلی به پلتفرم با مشکل مواجه شده است |
فایل CSV |
توضیحات: جهت انجام انتقال وجه گروهی کارتابلی ، ابتدا باید رکوردهای موردنظر را در فایلی با فرمت csv و با پارامترهای زیر اپلود کرد. ( در نسخه فعلی ، توسط سرویس انجام میشود ) هدر مربوط به فایل لیست تراکنش باید دارای فیلدهای زیر باشد .
firstName = نام صاحب شبا/کارت مقصد toolCode = روش انتقال وجه که پایا / ساتنا / کارت می باشد lastName= نام خانوادگی صاحب شبا /کارت مقصد Amount = مبلغ انتقال ( ریال ) toolId = شناسه کارت یا شبا ( براساس مقدار وارد شده در فیلد toolCode ) دقت شود که برای شبا نباید IR وارد شود. uniqueId = شناسه یکتای تراکنش که توسط کسب وکار ایجاد و ارسال میشود . currencyCode = مقدار ثابت IRR
برای پارامتر toolCode میتوان از مقادیر زیر استفاده کرد : انتقال پایا : SETTLEMENT_TOOL_PAYA انتقال ساتنا : SETTLEMENT_TOOL_SATNA انتقال کارت : SETTLEMENT_TOOL_CARD
فایل باید حتما در فرمت csv باشد که در غیر اینصورت خطا دریافت خواهید کرد. هدر پارامترهای ورودی در اولین خط از فایل پر می شود. هدرها روی بزرگ و کوچک بودن حروف حساس نیستند به طور مثال:toolcode-TOOLCODE-ToolCode همگی قابل قبول هستند. ترتیب قرارگیری هدرها، اهمیتی ندارند اما مهم هست که داده ها دقیقا در زیر هدر مربوط به خود وارد شوند به طور مثال آیدی های مربوط به هدر userId حتما باید در زیر هدر خود قرار گیرند. تمامی هدرهای الزامی در تراکنش مربوطه باید وارد شوند حتی اگر داده های داخل آن خالی ارسال شوند. نمونه هدرها: firstName,lastName,toolCode,toolId,amount,currencyCode,uniqueId برای ورود داده ها به صورت لیستی در فایل می بایست داده های هر پارامتر در یک خانه و با "-" از هم جدا شوند. به طور مثال برای پارامتر GuildCode که به صورت لیستی تعدادی Guild وارد شود، در هر خانه از جدول به صورت "guil1-guild2-guild3" ، داده ها وارد شوند. بنابر فرمت اصلی csv هر داده ای با "," از داده بعدی خود جدا می شود، اگر داده های زیر هر هدر خالی بود، لازم به وارد کردن داده ای نمی باشد. اما حتما باید بین دو “,” خالی قرار داده شود مانند" ", ," به طور مثال: (با توجه به نمونه، مقدار هر داده باید زیر هدر خود قرار گیرد. در اینجا با توجه به هدر قسمت 6 داده های lastName, currencyCode, خالی می باشند ) shadi8381422,,SETTLEMENT_TOOL_PAYA,290570021910012274315001,1500, ,57895255 |