سرویس پیچک

پارامتر

توضیحات

_token_

توکن کسب­وکاری دریافتی از پنل

_token_issuer_

مقدار ثابت "1"

پارامتر

توضیحات

scProductId

شناسه­‌ی سرویس مدنظر

scApiKey

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

پارامتر

نوع

توضیحات

callerTerminalName*

string (حداکثر 20 کاراکتر)

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

customerAuthStatus*

Int

0: فراخواننده‌ی سرویس، مشتری را احراز هویت نکرده است.

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

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

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

4: فراخواننده‌ی سرویس مشتری را احراز هویت حضوری کرده است.

پارامتر

نوع

توضیحات

BankCode*

string

کد بانک

Receivers*

Object array

شرح در جدول داده‌های دریافت‌کننده‌ی چک – جدول 1

IdentificationNumber*

string

شماره‌ شناسایی (شناسه‌ی ملی/ کد ملی)

IdentificationNumbersigners*

String array

لیست شماره شناسایی (کد ملی/شناسه‌ی ملی/شناسه‌ی فراگیر) امضاکنندگان

SayadId*

String (حداکثر 16 کاراکتر)

شناسه صیاد چک مورد نظر

SerialNo*

String (حداکثر 20 کاراکتر)

شماره سریال چک

SeriesNo*

String (حداکثر 10 کاراکتر)

شماره سری چک

Amount*

Long  (حداکثر 16 رقم)

مبلغ چک،

در هنگام صدور با میزان مانده اعتبار مشتری مقایسه می‌شود و در صورت عبور از میزان مانده اعتبار پیام خطا ارسال خواهد شد.

DueDate*

string

تاریخ خورشیدی سررسید چک (yyyymmdd)

Description*

String (حداکثر 250 کاراکتر)

شرح چک

ToIban

String (26 کاراکتر)

شماره شبای حساب مقصد با ساختار مطابق با ISO-13616

Reason

string

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

توضیحات این فیلد در بخش مقادیر مجاز برای بابت در بخش پیوست آورده شده است.

پارامتر

نوع

توضیحات

Name*

String

نام مشتری دریافت‌کننده (حداکثر 250 کاراکتر)

ShahabId

String

کد شهاب (16 رقم)

IdCode*

String

کد شناسایی دریافت‌کننده

مشتری حقیقی: کد ملی (10 رقم)

مشتری حقوقی: شناسه ملی شرکت (11 رقم)

اتباع بیگانه حقیقی و حقوقی: شماره‌ی فراگیر (حداکثر 16 رقم)

IdType*

Int

نوع کد شناسایی،

1: مشتری حقیقی

2: مشتری حقوقی

3: اتباع بیگانه‌ی حقیقی

4: اتباع بیگانه‌ی حقوقی

پارامتر

نوع

توضیحات

ResultData

Object array

آرایه‌ای از آبجکت‌ها طبق جدول 2

IsSuccess

Bool

نتیجه موفق یا ناموفق

Message

String

پیغام

RsCode

Int

کد وضعیت عملیات (جدول پیوست)

پارامتر

نوع

توضیحات

IsSuccess

Bool

نتیجه موفق یا ناموفق

Message

String

متن پیام

RsCode

Int

کد وضعبت عملیات (جدول پیوست)

BankCode

String

کد بانک

SayadId

String

شناسه‌ی صیاد چک مورد نظر

RequestTraceId

String

کد رهگیری

پارامتر

نوع

توضیحات

callerTerminalName*

string (حداکثر 20 کاراکتر)

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

customerAuthStatus*

Int

0: فراخواننده‌ی سرویس، مشتری را احراز هویت نکرده است.

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

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

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

4: فراخواننده‌ی سرویس مشتری را احراز هویت حضوری کرده است.

پارامتر

نوع

توضیحات

BankCode*

string

کد بانک

Accept*

int

0: رد چک

1: قبول چک

AcceptDescription

String (حداکثر 250 کاراکتر)

توضیح وضعیت تایید یا رد چک

SayadId*

String (حداکثر 16 کاراکتر)

شناسه صیاد چک مورد نظر

Acceptor

string

شماره مشتری تاییدکننده‌ی چک.

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

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

NationalIdAcceptor

string

شماره شناسایی (شناسه ملی/کد فیدا/کد ملی) تاییدکننده.

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

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

AcceptorAgent

string

شماره مشتری.

این فیلد اجباری شرطی می‌باشد.

درصورتی‌که ثبت‌کننده‌ی تایید، نماینده‌ی شخص حقوقی یا وکیل شخص گیرنده‌ی چک باشد این داده اجباری خواهد بود و تنها کافی است یکی از فیلدهای AcceptorAgent یا NationalIdAcceptorAgent در ورودی ارسال گردد.

NationalIdAcceptorAgent

string

شماره شناسایی (شناسه ملی/کد فیدا/کد ملی).

این فیلد اجباری شرطی می‌باشد.

درصورتی‌که ثبت‌کننده‌ی تایید، نماینده‌ی شخص حقوقی یا وکیل شخص گیرنده‌ی چک باشد این داده اجباری خواهد بود و تنها کافی است یکی از فیلدهای AcceptorAgent یا NationalIdAcceptorAgent در ورودی ارسال گردد.

پارامتر

نوع

توضیحات

ResultData

Object array

آرایه‌ای از آبجکت‌ها طبق جدول 2

IsSuccess

Bool

نتیجه موفق یا ناموفق

Message

String

پیغام

RsCode

Int

کد وضعیت عملیات (جدول پیوست)

پارامتر

نوع

توضیحات

IsSuccess

Bool

نتیجه موفق یا ناموفق

Message

String

متن پیام

RsCode

Int

کد وضعبت عملیات (جدول پیوست)

BankCode

String

کد بانک

SayadId

String

شناسه‌ی صیاد چک مورد نظر

RequestTraceId

String

کد رهگیری

پارامتر

نوع

توضیحات

callerTerminalName*

string (حداکثر 20 کاراکتر)

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

customerAuthStatus*

Int

0: فراخواننده‌ی سرویس، مشتری را احراز هویت نکرده است.

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

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

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

4: فراخواننده‌ی سرویس مشتری را احراز هویت حضوری کرده است.

پارامتر

نوع

توضیحات

BankCode*

string

کد بانک

Holder*

String (حداکثر 250 کاراکتر)

شماره مشتری صاحب چک (دارنده‌ی فعلی چک)

SayadId*

String (حداکثر 16 کاراکتر)

شناسه صیاد چک مورد نظر

AcceptTransfer

int

نظر دارنده‌ درباره‌ی انتقال (مقدار صفر یا یک)

0: انتقال را رده کرده است

1: انتقال را تایید کرده است

درحالت ذینفع مشترک، چنانچه ارسال‌کننده‌ی درخواست انتقال را رد کرده باشد، به لیست دریافت‌کنندگان توجه نمی‌شود. در غیر اینصورت ارسال‌کننده‌ی درخواست می‌بایست لیست یکسانی با لیست اعلامی توسط اولین ذینفع را ارسال کرده باشد. در حالتی که لیست چند امضاء‌کننده ارسال می‌شود، چنانچه همه تایید کرده باشند؛ تایید و در غیراینصورت رد ارسال می‌شود.

Description*

string

شرح انتقال چک (حداکثر 250 کاراکتر)

Receivers*

Object array

لیست دریافت‌کنندگان چک

جزئیات در جدول داده‌های دریافت‌کننده‌ی چک در انتقال

Signers*

Object array

لیست امضاکنندگان چک

جزئیات در جدول داده‌های امضا در انتقال چک.

در صورتی‌که امضاکننده نماینده نباشد، برای موارد امضاء حقوقی یا وکالتی باید صاحب چک هم باشد. در حالتی که دارنده‌ی فعلی حقوقی باشد و به امضاء چند امضاءدار نیاز باشد، باید لیست اطلاعات امضاءکننده‌ها ارسال شود.

ToIban

string

شماره شبای مقصد (26 کاراکتر)

با شاختار مطابق با ISO-13616

Reason

رشته‌ی کاراکتری به طول 4

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

توضیحات این قیلد در بخش مقادیر مجاز برای بابت، در بخش پیوست آورده شده است.

GiveBack

int

درصورتی‌که انتقال جهت عودت چک باشد این فیلد با مقدار 1 تعیین شود و درغیراینصورت 0 ارسال شود و یا ارسال نشود.

پارامتر

نوع

توضیحات

Name*

String

نام مشتری دریافت‌کننده (حداکثر 250 کاراکتر)

ShahabId

String

کد شهاب (16 رقم)

IdCode*

String

کد شناسایی دریافت‌کننده

مشتری حقیقی: کد ملی (10 رقم)

مشتری حقوقی: شناسه ملی شرکت (11 رقم)

اتباع بیگانه حقیقی و حقوقی: شماره‌ی فراگیر (حداکثر 16 رقم)

IdType*

Int

نوع کد شناسایی،

1: مشتری حقیقی

2: مشتری حقوقی

3: اتباع بیگانه‌ی حقیقی

4: اتباع بیگانه‌ی حقوقی

پارامتر

نوع

توضیحات

Signer*

object

اطلاعات مشتری امضاء‌کننده‌ی حقیقی

جزییات در جدول داده‌های امضاء‌کننده‌ی حقیقی انتقال چک می‌باشد.

LegalStamp*

Int

آیا این امضاء به منزله‌ی مهر حقوقی می‌باشد یا خیر؟

0: نمی‌باشد

1: می‌باشد

پارامتر

نوع

توضیحات

Name*

string

نام مشتری دریافت‌کننده (حداکثر 250 کاراکتر)

ShahabId*

string

کد شهاب (16 رقم)

IdCode*

string

کد شناسایی دریافت‌کننده

مشتری حقیقی: کد ملی (10 رقم)

مشتری حقوقی: شناسه ملی شرکت (11 رقم)

اتباع بیگانه حقیقی و حقوقی: شماره‌ی فراگیر (حداکثر 16 رقم)

IdType*

int

نوع کد شناسایی،

1: مشتری حقیقی

2: مشتری حقوقی

3: اتباع بیگانه‌ی حقیقی

4: اتباع بیگانه‌ی حقوقی

پارامتر

نوع

توضیحات

IsSuccess

bool

نتیجه موفق یا ناموفق

Message

string

پیغام

RequestTraceId

string

کد رهگیری

RsCode

int

کد وضعیت عملیات (جدول پیوست)

Resultcode

int

نتیجه‌ی تراکنش

1: انتقال انجام شد.

2: انتقال ثبت شد. انجام انتقال نیاز به تایید سایرین دارد.

3: تایید ثبت شد. با ثبت تایید سایرین انتقال انجام خواهد شد.

4: با تایید همه ذینفعان انتقال انجام شد.

5: انتقال با موفقیت لغو شد. انتقال جدید نیاز به تایید همه خواهد داشت.

پارامتر

نوع

توضیحات

callerTerminalName

string (حداکثر 20 کاراکتر)

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

customerAuthStatus*

int

0: فراخواننده‌ی سرویس، مشتری را احراز هویت نکرده است.

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

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

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

4: فراخواننده‌ی سرویس مشتری را احراز هویت حضوری کرده است.

پارامتر

نوع

توضیحات

BankCode*

string

کد بانک

CustomerNumber

string

شماره مشتری دارنده‌ی چک.

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

NationalId

string

شماره شناسایی (شناسه ملی/کد فیدا/کد ملی) دارنده‌ی چک.

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

SayadId*

string

شناسه صیاد چک مورد نظر (حداکثر 16 کاراکتر)

پارامتر

نوع

توضیحات

IsSuccess

bool

نتیجه موفق یا ناموفق

Message

string

پیغام

RsCode

int

کد وضعیت عملیات (جدول پیوست)

ResultData

Object array

طبق جدول ResultData

پارامتر

نوع

توضیحات

IsSuccess

bool

نتیجه موفق یا ناموفق

Message

string

پیغام

RsCode

int

کد وضعیت عملیات (جدول پیوست)

BankCode

string

کد بانک درخواست، که در ورودی دریافت شده است

SayadId

string

شناسه صیاد چک مورد نظر

Result

object

مشخصات چک، طبق جدول Result

پارامتر

نوع

توضیحات

SerialNo

string

سریال چک

SeriesNo

string

شماره سری چک

FromIban

string

کد شبا حساب عهده

Amount

string

مبلغ چک

DueDate

string

تاریخ خورشیدی سررسید چک

Description

string

شرح چک

BankCode

string

کد بانک عهده‌ی چک

BranchCode

string

کد شعبه‌ی عهده چک

Currency

string

نوع ارز چک

ChequeType

string

نوع چک:

1: عادی

2: بانکی

3: رمزدار

ChequeMedia

string

1: کاغذی

2: چک دیجیتال

ChequeStatus

string

وضعیت چک

مطابق جدول وضعیت‌های چک

guaranteeStatus

string

وضعیت ضمانت چک:

1: اینم چک فاقد ضمانت می‌باشد.

2: فرآیند ضمانت در جریان است.

3: فرآیند ضمانت ناتمام خاتمه یافته است.

4: فرآیند ضمانت اتمام و همه‌ی ضامن‌ها ضمانت کرده‌اند.

5: فرآیند ضمانت اتمام و برخی ضامن‌ها ضمانت را رد کرده‌اند.

BlockStatus

string

0: چک مسدود نشده است.

1: مسدود موقت می‌باشد.

2: مسدود دائم می‌باشد.

3: چک رفع مسدودی شده است.

Locked

string

0: Lock نقد کردن بر روی چک وجود ندارد.

1: چک Lock می‌باشد.

RequestTraceId

string

کد رهگیری

Holders

Object array

لیست دارندگان چک.

طبق جدول Holders

مقدار

وضعیت چک

1

ثبت شده با تایید گیرنده

2

نقد شده

3

باطل شده

4

برگشت خورده

5

بخشی برگشت‌خورده

6

در انتظار امضاء ضامن

7

در انتظار تایید گیرنده در کشیدن چک

8

در انتظار تایید گیرنده در انتقال چک

پارامتر

نوع

توضیحات

Name

string

نام مشتری دریافت‌کننده (حداکثر 250 کاراکتر)

IdCode

string

کد شناسایی دریافت‌کننده

مشتری حقیقی: کد ملی (10 رقم)

مشتری حقوقی: شناسه ملی شرکت (11 رقم)

اتباع بیگانه حقیقی و حقوقی: شماره‌ی فراگیر (حداکثر 16 رقم)

IdType

int

نوع کد شناسایی،

1: مشتری حقیقی

2: مشتری حقوقی

3: اتباع بیگانه‌ی حقیقی

4: اتباع بیگانه‌ی حقوقی

مقدار ارسالی

شرح

POSA

واریز حقوق

IOSP

امور بیمه خدمات

HIPA

امور درمانی

ISAP

امور سرمایه‌گذاری و بورس

FXAP

امور ارزی در چارچوب ضوابط و مقررات

DRPA

پرداخت قرض و تادیه دیون (قرض‌الحسنه، بدهی)

RTAP

امور بازنشستگی

MPTP

معاملات اموال منقول

IMTP

معاملات اموال غیرمنقول

LMAP

مدیریت نقدینگی

CDAP

عوارض گمرکی

TCAP

تسویه‌ی مالیاتی

GEAC

سایر خدمات دولتی

LRPA

تسهیلات و تعهدات

CCPA

تودیع وثیقه

GPAC

هزینه‌ی عمومی و امور روزمره

CPAC

کمک‌های خیریه

GPPC

خرید کالا

SPAC

خرید خدمات