مقدمه

سرویس‌های سامانه پل امکان انتقال وجه بین بانکی را به صورت حساب به حساب و آنی فراهم می‌کنند.

 سپس براساس ماهیت حساب بانکی خود ، یکی از دو فرم حقیقی / یا حقوقی زیر را دانلود و بعد از کامل نموندن اطلاعات موردنیاز ، آن را به یکی از شعبه بانک پاسارگاد تحویل دهید  .

دانلود فرم درخواست برای شخص حقیقی

دانلود فرم درخواست برای شخص حقوقی

پیش از شروع

  • 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) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.

 

انتقال وجه

با استفاده از سرویس انتقال وجه پل می‌توان دستور پرداخت انتقال وجه را صادر کرد.

  • شناسه سرویس: 3102812

  • پارامترهای ورودی:

فیلد

نوع

توضیحات

body

JSON object

 

body object:

فیلد

نوع

توضیحات

Identifier*

string

شناسه مبدا (در حال حاضر صرفا شماره شبا پشتیبانی می‌شود)

IdentifierType*

int

نوع شناسه مبدا.

طبق جدول.

(در حال حاضر صرفا نوع شماره شبا پشتیبانی می‌شود)

DepositNumber

string

شماره سپرده.

TransactionId*

string

شناسه یکتای تراکنش چهاربخشی.

طبق توضیحات

CustomerNumber*

string

شماره مشتری.

Amount*

double

مبلغ.

(مبلغ نمی‌بایست صفر یا عدد منفی باشد)

DestIBAN*

string

شماره شبای مقصد

TerminalType*

int

پذیرنده.

طبق جدول.

(در حال حاضر صرفا موبایل و اینترنت پشتیبانی می‌شود)

Description

string

شرح تراکنش

PurposeCode

int

بابت.

مربوط به پرداخت لحظه‌ای.

طبق جدول.

WithOutInquiry*

bool

بدون استعلام

CreditorFullName*

string

نام و نام خانوادگی ذینفع

PaymentId

string

شناسه واریز.

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

EffectiveDate

string

تاریخ پرداخت موثر (در آینده).

YYYY/MM/DD-HH:MM:SS

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

مقادیر IdentifierType:

کد

نام

1

شماره شبا

2

شماره سپرده

3

شماره کارت

مقادیر TerminalType:

کد

نام

1

Branch

2

Internet

3

Mobile

4

ATM

5

Pol

مقادیر PurposeCode:

 

توضیحات

کد

DRPA

پرداخت قرض و تادیه دیون

1

POSA

واریز حقوق

2

IOSP

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

3

HIPA

امور درمانی

4

ISAP

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

5

FXAP

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

6

RTAP

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

7

MPTP

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

8

IMPT

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

9

LMAP

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

10

CDAP

عوارض گمرکی

11

TCAP

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

12

GEAC

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

13

LRPA

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

14

CCPA

تودیع وثیقه

15

GPAC

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

16

CPAC

کمک های خیریه

17

GPPC

خرید کالا

18

SPAC

خرید خدمات

19

نکته: شناسه تراکنش‌ها (TransactionId) شامل چهار بخش به شکل زیر می‌باشد:

4321 - Random String – DateTime-Sum Char Code(OrgCode+Random String+DateTime)

Random String: یک رشته‌ی تصادفی که به ازای هر کلاینت یکتا است، حداقل طول کاراکتر و حداکثر طول آن 100 است.

DateTime: تاریخ (میلادی) و ساعت (با فرمت 24ساعته) با دقت میلی‌ثانیه. به‌عنوان مثال:

4321-123456789-20220618113511111-1531

تاریخ و ساعت بالا به 18 ژوئن 2022، ساعت 11:35:11.111 اشاره دارد.

Sum Char Code: جمع کد اسکی کاراکترهای سه بخش قبل

نمونه جیسان ارسالی:

json

 

  • خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.

 بدنه­‌ی پاسخ دریافتی دارای ساختار زیر است:

پارامتر

نوع

توضیحات

IsSuccess

bool

موفق یا ناموفق بودن دریافت لیست سپرده­ها

RsCode

int

کد وضعیت عملیات

Message

string

پیام

ResultData

object

خروجی موفق – طبق جدول

ErrorList

list

خروجی ناموفق – طبق جدول

 

json

 

 

پارامتر

نوع

توضیحات

ReferenceNumber

string

شماره پیگیری تراکنش

بررسی object ErrorList:

پارامتر

نوع

توضیحات

Code

int

کد خطا

Desc

string

پیغام خطا

ParamName

string

نام پارامتر دارای خطا

ParamPath

string

مسیر پارامتر دارای خطا

نکته: در صورتی که مشتری ریسک عدم دریافت پاسخ استعلام (به هر دلیل) از بانک مقصد را بپذیرد، پارامتر "بدون استعلام" می‌بایست با مقدار true ارسال گردد و در این صورت استعلام صورت نمی‌پذیرد.

در این شرایط و به دلیل تاکید مشتری بر انجام دستور پرداخت، ارسال نام و نام خانوادگی ذینفع به (جهت ارسال به بانک مرکزی) مورد نظر الزامی است. در غیر اینصورت پارامتر "بدون استعلام" می­بایست با "false" ارسال گردد، در این شرایط دیگر ارسال نام و نام خانوادگی ذینفع مورد نیاز نمی‌باشد و در صورت ارسال، پردازشی بر روی آن صورت نخواهد گرفت.

نمونه پاسخ موفق:

json

 

نمونه پاسخ ناموفق:

json

 

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

 جهت امکان دسترسی مشتری به گزارشی از تراکنش­های بدهکاری پل صورت گرفته با شماره شبا خود (سپرده­اش) از طریق اینترنت بانک و یا موبایل بانک، سامانه­ی­ اینترنت بانک می­بایست سرویسی معادل این مفهوم را فراخوانی کند.

  • شناسه سرویس: 3102814

  • فیلدهای ورودی:

فیلد

نوع

توضیحات

ReferenceNumber

string

کد پیگیری تراکنش

TransactionIdentification

string

شناسه تراکنش

CustomerNumber

string

شماره مشتری متعهد

DepositNumber

string

شماره سپرده متعهد

IBAN

string

شماره شبا متعهد

DestIBAN

string

شماره شبا ذینفع

DateFrom

string

شروع بازه‌ی تاریخ و ساعت تراکنش

YYYY/MM/DD-HH:MM:SS

DateTo

string

پایان بازه‌ی تاریخ و ساعت تراکنش

YYYY/MM/DD-HH:MM:SS

(حداکثر بازه‌ی تاریخ مجاز برابر است با 7 روز)

AmountFrom

double

شروع بازه‌ی مبلغ

AmountTo

double

پایان بازه‌ی مبلغ

NumberOfTransactions

int

تعداد چند گردش آخر.

حداکثر 20 تراکنش

TerminalType

int

نوع ترمینال

مقادیر TerminalType:

کد

نام

1

Branch

2

Internet

3

Mobile

4

ATM

5

Pol

نکته: برای دریافت نتیجه‌ی گزارش در صورت فراخوانی این سرویس، ارسال حداقل ورودی‌ها (یکی از پنج مورد زیر) الزامی است:

  • کد پیگیری تراکنش
  • شناسه تراکنش
  • شماره مشتری متعهد به‌علاوه‌ی بازه‌ی زمانی یا تعداد چند گردش آخر
  • شماره سپرده متعهد به‌علاوه‌ی بازی زمانی یا تعداد چند گردش آخر
  • شماره شبا متعهد به‌علاوه‌ی بازه‌ی زمانی یا تعداد چند گردش آخر

نمونه جیسان ارسالی:

json

 

 

  • خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.

 بدنه­‌ی پاسخ دریافتی دارای ساختار زیر است:

پارامتر

نوع

توضیحات

IsSuccess

bool

موفق یا ناموفق بودن دریافت لیست سپرده­ها

RsCode

int

کد وضعیت عملیات

Message

string

پیام

ResultData

object

خروجی موفق – طبق جدول

ErrorList

list

خروجی ناموفق – طبق جدول

 

بررسی object ResultData:

پارامتر

نوع

توضیحات

Transactions

List object

اطلاعات تراکنش‌ها

بررسی Transactions object: این پارامتر شامل لیستی از تراکنش‌هاست که اطلاعات هر تراکنش شامل موارد زیر است:

پارامتر

نوع

توضیحات

CustomerNumber

string

شماره مشتری متعهد

DepositNumber

string

شماره سپرده متعهد

IBAN

string

شماره شبا متعهد

DestIBAN

string

شماره شبا ذینفع

DebtorName

string

نام و نام خانوادگی متعهد

CreditorName

string

نام و نام خانوادگی ذینفع

OriginalAmount

double

مبلغ اصلی تراکنش

Amount

double

مبلغ تراکنش

OriginalFreeAmount

double

مبلغ اصلی کارمزد

FreeAmount

double

مبلغ کارمزد

Date

string

تاریخ تراکنش

Time

string

ساعت تراکنش

State

int

وضعیت تراکنش.

موفق: 0

ناموفق: 1

ثبت‌شده: 2

ردشده: 3

درحال پردازش: 4,5,6

TerminalType

int

نوع ترمینال

شعبه: 1

اینترنت‌بانک: 2

موبایل‌بانک: 3

ReferenceNumber

string

کد پیگیری تراکنش

(برای تراکنش‌های بازپرداخت، با کد پیگیری تراکنش اصلی پر می‌شود.)

TransactionIdentification

string

شناسه تراکنش

OrgTransactionIdentification

string

شناسه تراکنش اصلی

(این فیلد فقط برای تراکنش‌های بازپرداخت پر می‌شود)

TransactionType

int

نوع تراکنش.

برداشت: 1

بازپرداخت جزئی برداشت: 3

بازپرداخت کل برداشت: 5

Description

string

شرح تراکنش.

(در صورت وجود پر می‌شود)

 نکته: از اختلاف مبلغ اصلی تراکنش و مبلغ تراکنش، "مقدار مبلغ تراکنش" تراکنش بازپرداخت مشخص می‌گردد.

نکته: از اختلاف مبلغ اصلی کارمزد و مبلغ کارمزد، "مقدار مبلغ کارمزد" تراکنش بازپرداخت مشخص می‌گردد.

بررسی object ErrorList:

پارامتر

نوع

توضیحات

Code

int

کد خطا

Desc

string

پیغام خطا

ParamName

string

نام پارامتر دارای خطا

ParamPath

string

مسیر پارامتر دارای خطا

نمونه پاسخ موفق:

{

  "ReferenceNumber": "",

  "TransactionIdentification": "",

  "CustomerNumber": "",

  "DepositNumber": "",

  "IBAN": "IR870570000101000002020015",

  "DestIBAN": "",

  "DateFrom": "1400/04/09-00:00:00",

  "DateTo": "1400/04/09-23:59:59",

  "AmountFrom": null,

  "AmountTo": null,

  "NumberOfTransactions": null,

  "TerminalType": null

}

json

 

نمونه پاسخ ناموفق:


کدهای ارور (errorCode) معمول در پلتفرم

برای مشاهده‌ی کدهای ارور پلتفرم به این لینک مراجعه کنید.

کدهای خطای (RsCode) سرویس‌های اصلی

  • انتقال وجه:

کد

پیغام

0

به علت بروز مشکل عملیات شما انجام نشد

1

عمليات با موفقيت انجام شد

804

مدت زمان پردازش پیام منقضی شده است

805

خطا در فراخوانی سرویس

1038

اطلاعات ورودي اشتباه مي باشد.

1194

مقدار نامعتبر است

1207

فرمت تاریخ نامعتبر

1313

فيلد خالي است

3064

پارامتر اجباری وارد نشده است

  • استعلام تراکنش:

کد

پیغام

0

به علت بروز مشکل عملیات شما انجام نشد

1

عمليات با موفقيت انجام شد

804

مدت زمان پردازش پیام منقضی شده است

805

خطا در فراخوانی سرویس

1038

اطلاعات ورودي اشتباه مي باشد.

1107

مبلغ ورودی صحیح نیست.

1117

تاریخ پایان می‌بایست بزرگتر از تاریخ شروع باشد.

1130

تاریخ شروع نامعتبر است.

1131

تاریخ پایان نامعتبر است.

1066

متاسفانه، اطلاعات ارسال شده نامعتبر است

1194

مقدار نامعتبر است

1207

فرمت تاریخ نامعتبر

1685

مبلغ واردشده نامعتبر است.

2947

فیلدهای واردشده کافی نمی‌باشد.

1122

رکوردی یافت نشد.

نکته: در صورتی که سرویس‌دهنده خطایی خارج از موارد اعلامی بازگرداند (خطای خارج از انتظار)، کد خطای 0 به همراه پاسخ سرویس‌دهنده بازگردانده می‌شود.

Clasor npm package version 2.1.4
به پادیوم قدرت داده اند:
pasargad
fanap
pod