Navigation
curl php

مقدمه

این راهنما نحوه اتصال برنامه نویسان به API‌های جیبی‌مو را توضیح می‌دهد.

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

وب سرویس‌های پایه

اعتبار‌سنجی

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


curl -X POST https://jibimo.com/v2/auth/token\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d'{
"username": "jibimo",
"password": "1234",
"secret_key": "4LjCy8************",
"scopes": ["iban-inquiry"]
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/auth/token', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/auth/token

ساختار ورودی

عنوان نوع اجباری توضیحات
username string بله نام کاربری درخواست کننده
password string بله رمز عبور درخواست کننده
secret_key string بله کلید واحدی که به هر کسب‌و‌کار تعلق دارد
scopes [string] خیر برای مشخص شدن سطح دسترسی

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

نکته : مقدار scopes در توضیحات API هر قسمت وجود دارد.

خروجی کد وضعیت 200

{
"token_type": "Bearer",
"expires_in": 1800,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
"refresh_token": "def502008c9703c9cd4b1b564111eb3dca340fc2f6e995aef4d005a8"
}

خروجی کد وضعیت 401

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

{
"message": "کلید وارد شده معتبر نمی باشد"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
401 عدم اعتبار‌سنجی

ساختار خروجی

عنوان نوع توضیحات
token_type string نوع توکن بازگشتی
expires_in number زمان انقضای توکن
access_token string توکن
refresh_token string توکن بازیابی

بازیابی توکن

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


curl -X POST https://jibimo.com/v2/auth/token/refresh\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d'{
"refresh_token": "def502005c9708c9cd4b1b564111eb3dca340fc2"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/auth/token/refresh', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/auth/token/refresh

ساختار ورودی

عنوان نوع اجباری توضیحات
refresh_token string بله توکن بازیابی

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

خروجی کد وضعیت 200

{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
"refresh_token": "def502008c9703c9cd4b1b564111eb3dca340fc2f6e995aef4d005a8"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق

ساختار خروجی

عنوان نوع توضیحات
token_type string نوع توکن بازگشتی
expires_in number زمان انقضای توکن
access_token string توکن
refresh_token string توکن بازیابی

وضعیت موجودی

با فراخوانی آدرس زیر به صورت GET و ارسال توکن دریافتی در Header درخواست به عنوان Authorization می‌توانید موجودی حساب خود را دریافت کنید.


curl -X GET https://jibimo.com/balance \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/balance', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/balance

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
401 عدم اعتبار‌سنجی

ساختار خروجی

عنوان نوع توضیحات
balance string موجودی
reserved string موجودی رزرو شده

درگاه پرداخت

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

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

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

وب سرویس‌ها به صورت Restful هستند.

اعتبار‌سنجی

جهت استفاده از این وب سرویس باید مراحل زیر را طی کنید:

۱- ثبت‌نام از طریق لینک app.jibimo.com

۲- ثبت کسب‌وکار و انتظار جهت تائید کارشناسان

۳- ورود به پنل کسب‌وکار و ایجاد توکن

بعد از دریافت توکن می‌توانید برای فراخوانی API از آن استفاده کنید.

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

X-API-KEY: a7049f02-****-****-****-********53a4

درخواست تراکنش

در مرحله اول شما باید پارامترهای زیر را با متد POST به آدرسی که مشخص شده است ارسال کنید.


curl -X POST https://jibimo.com/v2/ipg/request \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEY: a7049f02-****-****-****-********53a4'\
-d '{
"amount": 10000,
"mobile_number": 989000000000,
"return_url": "https://yourdomain.ir"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-API-KEY' => 'a7049f02-****-****-****-********53a4',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/ipg/request', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}

https://jibimo.com/v2/ipg/request

ساختار ورودی

عنوان نوع اجباری توضیحات
amount number بله مبلغ تراکنش به ریال - حداقل ۱۰٫۰۰۰ ریال حداکثر ۵۰۰٫۰۰۰٫۰۰۰ ریال
mobile_number string بله شماره موبایل مشتری جهت واکشی اطلاعات کارت - در صورتی که کارتی برای این شماره موبایل در دیتابیس شرکت پرداخت الکترونیک ذخیره شده باشد لیست کارت‌ها در درگاه بانکی نمایش داده می‌شود تا در صورت نیاز کاربر با انتخاب آن دیگر نیازی به وارد کردن اطلاعات کارت نداشته باشد. نکته : حتماً از شماره موبایل خریدار استفاده کنید و به هیچ وجه از یک شماره موبایل ثابت در تمام پرداخت‌ها استفاده نکنید.
return_url string خیر آدرس صفحه‌ای از سایت شما برای بازگشت کاربر از درگاه بعد از تکمیل پرداخت و یا انصراف از آن

خروجی کد وضعیت 200

{
"trx": "transaction_code",
"link": "https://jibimo.com/v2/ipg/redirect/MjM1ODM1"
}

خروجی کد وضعیت 424

{
"errors": {
"token": "خطا در پرداخت, چند ثانیه دیگر تلاش کنید"
}
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
424 خطای بانک

ساختار خروجی

عنوان نوع توضیحات
trx number شناسه تراکنش که برای پیگیری و عملیات verify استفاده خواهد شد
link string لینک هدایت کاربر به درگاه بانک

بازگشت به سایت پذیرنده

بعد از اتمام عملیات پرداخت، درصورتیکه پرداخت با موفقیت انجام شده باشد، پرداخت کننده به آدرسی که پذیرنده در return_url مشخص کرده بود به همراه پارامتر‌های status و trx و state_code منتقل می‌شود.

return_url?status=1&trx=MjM1ODMw&state_code=99

پارامتر‌های ارسالی

عنوان نوع توضیحات
status number وضعیت (۱ موفق و ۰ ناموفق)
state_code number کد وضعیت
trx number شناسه تراکنشی که در مرحله اول دریافت کرده‌اید

مقادیر کد وضعیت (state_code)

کد توضیحات
3- کاربر در درگاه بانکی روی انصراف کلیک کرده است
4- خطا در پرداخت (با پشتیبانی تماس بگیرید)
99 پول از حساب کاربر برداشت شده و منتظر verify شدن است

تائید تراکنش

پس از خرید موفقِ مشتری و بازگشت وی به سایت شما (return_url)، به مدت ۳۰ دقیقه فرصت دارید تراکنش انجام شده را verify کنید و به اتمام برسانید. در غیر این این صورت پس از گذشت این زمان تراکنش رد می‌شود و مبلغ به حساب خریدار عودت داده می‌شود.

برای اینکار شما باید پارامترهای زیر را با متد POST به آدرسی که مشخص شده است ارسال کنید.


curl -X POST https://jibimo.com/v2/ipg/verify \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEY: a7049f02-****-****-****-********53a4'\
-d'{
"trx": "MjM1ODMw"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-API-KEY' => 'a7049f02-****-****-****-********53a4',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/ipg/verify', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/ipg/verify

ساختار ورودی

عنوان نوع اجباری توضیحات
trx string بله شناسه تراکنشی که در مرحله اول دریافت کرده‌اید

خروجی کد وضعیت 200

{
"status": 1,
"state_code": 100,
"amount": 10000,
"mobile_number": "+989000000000",
"card_number": "621986******3238",
"card_hash": "6BA39385AF1599EB4BFADA1DC3B7A9976DB7B248E93CC4D89237650D472D8391",
"date": "2021-03-12 20:57:19",
"card_owner": "محمد محمدی",
"tracking_id": "MjM1ODMw"
}

خروجی کد وضعیت 424

{
"status": 0,
"state_code": -6,
"amount": 10000,
"mobile_number": "+989000000000",
"card_number": null,
"card_hash": null,
"date": null,
"card_owner": "محمد محمدی",
"tracking_id": "MjM1ODMw"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
424 خطای بانک

ساختار خروجی

عنوان نوع توضیحات
status number وضعیت (۱ موفق و ۰ ناموفق)
state_code number کد وضعیت
amount number مبلغ تراکنش
mobile_number string شماره موبایل وارد شده زمان ساخت تراکنش
card_number string شماره کارت mask شده (۶ رقم از شماره کارت به * تبدیل می‌شود)
card_hash string شماره کارت هش شده با الگوریتم SHA-256
date string زمان انجام تراکنش
card_owner string نام مالک
tracking_id string شناسه تراکنش

مقادیر کد وضعیت (state_code)

کد توضیحات
3- کاربر در درگاه بانکی روی انصراف کلیک کرده است
4- خطا در پرداخت (با پشتیبانی تماس بگیرید)
99 پول از حساب کاربر برداشت شده و منتظر verify شدن است

استعلام وضعیت تراکنش

با ارسال پارامتر‌های زیر به صورت GET می‌توانید آخرین وضعیت یک تراکنش را دریافت نمایید.


curl -X GET https://jibimo.com/v2/ipg/trx/{trx} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEY: a7049f02-****-****-****-********53a4'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'X-API-KEY' => 'a7049f02-****-****-****-********53a4',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/v2/ipg/trx/{trx}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/ipg/trx/{trx}

ساختار ورودی

عنوان نوع اجباری توضیحات
trx number بله شناسه تراکنش

خروجی کد وضعیت 200

{
"status": 1,
"state_code": 100,
"amount": 10000,
"mobile_number": "+989000000000",
"card_number": "621986******3238",
"card_hash": "6BA39385AF1599EB4BFADA1DC3B7A9976DB7B248E93CC4D89237650D472D8391",
"date": "2021-03-12 20:57:19",
"card_owner": "محمد محمدی",
"tracking_id": "MjM1ODMw"
}

خروجی کد وضعیت 424

{
"status": 0,
"state_code": -6,
"amount": 10000,
"mobile_number": "+989000000000",
"card_number": null,
"card_hash": null,
"date": null,
"card_owner": "محمد محمدی",
"tracking_id": "MjM1ODMw"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
424 خطای بانک

ساختار خروجی

عنوان نوع توضیحات
status number وضعیت (۱ موفق و ۰ ناموفق)
state_code number کد وضعیت
amount number مبلغ تراکنش
mobile_number string شماره موبایل وارد شده زمان ساخت تراکنش
card_number string شماره کارت mask شده (۶ رقم از شماره کارت به * تبدیل می‌شود)
card_hash string شماره کارت هش شده با الگوریتم SHA-256
date string زمان انجام تراکنش
card_owner string نام مالک
tracking_id string شناسه تراکنش

احراز هویت دیجیتال

در سیستم‌های مالی احراز هویت بخش جدایی ناپذیر از فرایند ارائه خدمات به مشتریان است. با توجه به اینکه جیبی‌مو زیر ساخت خدمات مالی ارائه می‌دهد، خدمات احراز هویت دیجیتال آن هم رنگ و بوی مالی دارد. برای مثال یک بنگاه اقتصادی که پرداخت‌هایی به مشتریان زیادی دارد، نیاز دارد تا قبل از پرداخت مطمئن شود که حساب مقصد فعال است و متعلق خود فرد است. این کار با کمک وب سرویس‌های جیبی‌مو به صورت اتوماتیک در می‌آید.

وب سرویس‌ها به صورت Restful هستند.

اعتبار‌سنجی

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


curl -X POST https://jibimo.com/v2/auth/token\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d'{
"username": "jibimo",
"password": "1234",
"secret_key": "4LjCy8************",
"scopes": ["iban-inquiry"]
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/auth/token', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/auth/token

ساختار ورودی

عنوان نوع اجباری توضیحات
username string بله نام کاربری درخواست کننده
password string بله رمز عبور درخواست کننده
secret_key string بله کلید واحدی که به هر کسب‌و‌کار تعلق دارد
scopes [string] خیر برای مشخص شدن سطح دسترسی

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

نکته : مقدار scopes در توضیحات API هر قسمت وجود دارد.

خروجی کد وضعیت 200

{
"token_type": "Bearer",
"expires_in": 1800,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
"refresh_token": "def502008c9703c9cd4b1b564111eb3dca340fc2f6e995aef4d005a8"
}

خروجی کد وضعیت 401

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

{
"message": "کلید وارد شده معتبر نمی باشد"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
401 عدم اعتبار‌سنجی

ساختار خروجی

عنوان نوع توضیحات
token_type string نوع توکن بازگشتی
expires_in number زمان انقضای توکن
access_token string توکن
refresh_token string توکن بازیابی

بازیابی توکن

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


curl -X POST https://jibimo.com/v2/auth/token/refresh\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d'{
"refresh_token": "def502005c9708c9cd4b1b564111eb3dca340fc2"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/auth/token/refresh', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/auth/token/refresh

ساختار ورودی

عنوان نوع اجباری توضیحات
refresh_token string بله توکن بازیابی

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

خروجی کد وضعیت 200

{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
"refresh_token": "def502008c9703c9cd4b1b564111eb3dca340fc2f6e995aef4d005a8"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق

ساختار خروجی

عنوان نوع توضیحات
token_type string نوع توکن بازگشتی
expires_in number زمان انقضای توکن
access_token string توکن
refresh_token string توکن بازیابی

استعلام شماره شبا

با ارسال پارامتر‌های زیر به صورت POST می‌توانید عملیات استعلام یک شماره شبا را انجام دهید.


curl -X POST https://jibimo.com/v2/iban-inquiry \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian' \
-d '{
"iban": "IR330170000000200150094006"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/iban-inquiry', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/iban-inquiry

scope: iban-inquiry

ساختار ورودی

عنوان نوع اجباری توضیحات
iban string بله شماره شبا

خروجی کد وضعیت 200

{
"owners": [
{
"firstName": "محمد",
"lastName": "محمدی"
}
],
"account_number": "838-***-******-*",
"account_status": "ACTIVE",
"account_comment": "سپرده سرمايه گذاري کوتاه مدت",
"bank": {
"name": "سامان",
"logo": "https://jibimo.com/storage//bank/13/logo/saman.png"
}
}

خروجی کد وضعیت 400

{
"success": false,
"errors": [
"شبا نامعتبر است."
]
}

خروجی کد وضعیت 424

{
"success": false,
"errors": [
"بانک پاسخگو نیست."
]
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
400 ورودی نامعتبر
403 خطای دسترسی
404 آدرس نامعتبر
424 خطای بانک

ساختار خروجی

عنوان نوع توضیحات
owners [object] اطلاعات صاحبان حساب
account_number string شماره حساب
account_status string وضعیت حساب
account_comment string توضیحات
bank object اطلاعات بانک

ساختار خروجی owners

عنوان نوع توضیحات
firstName string نام
lastName string نام خانوادگی
nationalIdentifier string کد ملی صاحب حساب
customerType string نوع مشتری

نکته : با توجه به اینکه ممکن است استعلام توسط بانک‌های مختلف صورت بگیرد اطلاعات قسمت owners می‌تواند شامل موارد کد ملی صاحب حساب و نوع مشتری نباشد.

ساختار خروجی bank

عنوان نوع توضیحات
name string نام
logo string لوگو

مقادیر وضعیت حساب (account_status)

کد وضعیت توضیحات
ACTIVE حساب فعال است
KHATA خطا
RAKED حساب غیر فعال است
MASDOD_BA_GHABELIAT_VARIZ مسدود با قابلیت واریز
MASDOD_BEDONE_GHABELIAT_VARIZ مسدود بدون قابلیت واریز
OTHER حالات دیگر

استعلام شماره شبا و تطبیق هویت

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


curl -X POST https://jibimo.com/v2/iban-inquiry \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian' \
-d '{
"iban": "IR33017000****************",
"first_name": "محمد",
"last_name": "محمدی"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/iban-inquiry', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/iban-inquiry

scope: iban-inquiry

ساختار ورودی

عنوان نوع اجباری توضیحات
iban string بله شماره شبا
first_name string بله نام
last_name string بله نام خانوادگی

خروجی کد وضعیت 200

{
"owners": [
{
"firstName": "محمد",
"lastName": "محمدی"
}
],
"account_number": "838-***-******-*",
"account_status": "ACTIVE",
"account_comment": "سپرده سرمايه گذاري کوتاه مدت",
"bank": {
"name": "سامان",
"logo": "https://jibimo.com/storage//bank/13/logo/saman.png"
},
"matching": {
"first_name": 100,
"last_name": 100,
"full_name": 100,
"status": "match"
}
}

خروجی کد وضعیت 400

{
"success": false,
"errors": [
"شبا نامعتبر است."
]
}

خروجی کد وضعیت 424

{
"success": false,
"errors": [
"بانک پاسخگو نیست."
]
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
400 ورودی نامعتبر
403 خطای دسترسی
404 آدرس نامعتبر
424 خطای بانک

ساختار خروجی

عنوان نوع توضیحات
owners [object] اطلاعات صاحبان حساب
account_number string شماره حساب
account_status string وضعیت حساب
account_comment string توضیحات
bank object اطلاعات بانک
matching object تطابق

ساختار خروجی owners

عنوان نوع توضیحات
firstName string نام
lastName string نام خانوادگی
nationalIdentifier string کد ملی صاحب حساب
customerType string نوع مشتری

نکته : با توجه به اینکه ممکن است استعلام توسط بانک‌های مختلف صورت بگیرد اطلاعات قسمت owners می‌تواند شامل موارد کد ملی صاحب حساب و نوع مشتری نباشد.

ساختار خروجی bank

عنوان نوع توضیحات
name string نام
logo string لوگو

ساختار خروجی matching

عنوان نوع توضیحات
first_name number درصد تطابق نام
last_name number درصد تطابق نام خانوادگی
full_name number درصد تطابق نام و نام خانوادگی
status string وضعیت تطابق

مقادیر وضعیت تطابق (status)

وضعیت توضیحات
match تطابق کامل
partial_match تطابق نسبی
not_match عدم تطابق

استعلام شماره حساب

با ارسال پارامتر‌های زیر به صورت POST می‌توانید عملیات استعلام یک شماره حساب را انجام دهید.


curl -X POST https://jibimo.com/v2/account-inquiry \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian' \
-d '{
"account_number": "200*********",
"bank_code": "017"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/account-inquiry', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/account-inquiry

scope: account-inquiry

ساختار ورودی

عنوان نوع اجباری توضیحات
account_number string بله شماره حساب
bank_code string بله کد بانک (لیست کد بانک‌ها)

خروجی کد وضعیت 200

{
"iban": "IR33017000****************",
"owners": [
{
"firstName": "محمد",
"lastName": "محمدی"
}
],
"account_number": "838-***-******-*",
"account_status": "ACTIVE",
"account_comment": "سپرده سرمايه گذاري کوتاه مدت",
"bank": {
"name": "سامان",
"logo": "https://jibimo.com/storage//bank/13/logo/saman.png"
}
}

خروجی کد وضعیت 400

{
"success": false,
"errors": [
"شبا نامعتبر است."
]
}

خروجی کد وضعیت 424

{
"success": false,
"errors": [
"بانک پاسخگو نیست."
]
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
400 ورودی نامعتبر
403 خطای دسترسی
404 آدرس نامعتبر
424 خطای بانک

ساختار خروجی

عنوان نوع توضیحات
iban string شماره شبا
owners [object] اطلاعات صاحبان حساب
account_number string شماره حساب
account_status string وضعیت حساب
account_comment string توضیحات
bank object اطلاعات بانک

ساختار خروجی owners

عنوان نوع توضیحات
firstName string نام
lastName string نام خانوادگی
nationalIdentifier string کد ملی صاحب حساب
customerType string نوع مشتری

نکته : با توجه به اینکه ممکن است استعلام توسط بانک‌های مختلف صورت بگیرد اطلاعات قسمت owners می‌تواند شامل موارد کد ملی صاحب حساب و نوع مشتری نباشد.

ساختار خروجی bank

عنوان نوع توضیحات
name string نام
logo string لوگو

مقادیر وضعیت حساب (account_status)

وضعیت توضیحات
ACTIVE حساب فعال است
KHATA خطا
RAKED حساب غیر فعال است
MASDOD_BA_GHABELIAT_VARIZ مسدود با قابلیت واریز
MASDOD_BEDONE_GHABELIAT_VARIZ مسدود بدون قابلیت واریز
OTHER حالات دیگر

استعلام شماره حساب و تطبیق هویت

در این قسمت با ارسال پارامتر‌های زیر به صورت POST می‌توانید وضعیت تطابق شماره حساب استعلام شده با اطلاعات ورودی را بررسی کنید.


curl -X POST https://jibimo.com/v2/account-inquiry \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian' \
-d '{
"account_number": "200*********",
"bank_code": "017",
"first_name": "محمد",
"last_name": "محمدی"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/account-inquiry', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/account-inquiry

scope: account-inquiry

ساختار ورودی

عنوان نوع اجباری توضیحات
account_number string بله شماره حساب
bank_code string بله کد بانک (لیست کد بانک‌ها)
first_name string بله نام
last_name string بله نام خانوادگی

خروجی کد وضعیت 200

{
"iban": "IR33017000****************",
"owners": [
{
"firstName": "محمد",
"lastName": "محمدی"
}
],
"account_number": "838-***-******-*",
"account_status": "ACTIVE",
"account_comment": "سپرده سرمايه گذاري کوتاه مدت",
"bank": {
"name": "سامان",
"logo": "https://jibimo.com/storage//bank/13/logo/saman.png"
},
"matching": {
"first_name": 100,
"last_name": 100,
"full_name": 100,
"status": "match"
}
}

خروجی کد وضعیت 400

{
"success": false,
"errors": [
"شبا نامعتبر است."
]
}

خروجی کد وضعیت 424

{
"success": false,
"errors": [
"بانک پاسخگو نیست."
]
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
400 ورودی نامعتبر
403 خطای دسترسی
404 آدرس نامعتبر
424 خطای بانک

ساختار خروجی

عنوان نوع توضیحات
iban string شماره شبا
owners [object] اطلاعات صاحبان حساب
account_number string شماره حساب
account_status string وضعیت حساب
account_comment string توضیحات
bank object اطلاعات بانک
matching object تطابق

ساختار خروجی owners

عنوان نوع توضیحات
firstName string نام
lastName string نام خانوادگی
nationalIdentifier string کد ملی صاحب حساب
customerType string نوع مشتری

نکته : با توجه به اینکه ممکن است استعلام توسط بانک‌های مختلف صورت بگیرد اطلاعات قسمت owners می‌تواند شامل موارد کد ملی صاحب حساب و نوع مشتری نباشد.

ساختار خروجی bank

عنوان نوع توضیحات
name string نام
logo string لوگو

ساختار خروجی matching

عنوان نوع توضیحات
first_name number درصد تطابق نام
last_name number درصد تطابق نام خانوادگی
full_name number درصد تطابق نام و نام خانوادگی
status string وضعیت تطابق

مقادیر وضعیت تطابق (status)

وضعیت توضیحات
match تطابق کامل
partial_match تطابق نسبی
not_match عدم تطابق

پرداخت گروهی

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

1- در صورت نیاز قبل از پرداخت می‌توانید کانفیگ‌هایی را فعال نمایید تا از طریق آن حساب‌های غیر قابل واریز را شناسایی کنید و یا پس از اطلاع از هویت صاحب حساب اقدام به پرداخت کنید.

2- پس از ارسال تراکنش‌ها به بانک لحظه به لحظه از وضعیت تراکنش با خبر می‌شوید.

3- امکان ارسال رسید آنلاین به مشتری را خواهید داشت.

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

5- امکان ارتباط با مشتری و تغییر حساب‌ها را خواهید داشت تا در صورت اصلاح توسط مشتری، مجدداً برای پرداخت اقدام کنید.

6- گزارشات مدیریتی و همچنین با جزئیات دقیق، امکان نظارت و کنترل روی وضعیت لحظه‌ای تمام تراکنش‌ها را در اختیار بخش مالی قرار خواهد داد.

7- سطوح دسترسی برای مدیران، پشتیبانان وجود دارد.

وب سرویس‌ها به صورت Restful هستند.

اعتبار‌سنجی

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


curl -X POST https://jibimo.com/v2/auth/token\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d'{
"username": "jibimo",
"password": "1234",
"secret_key": "4LjCy8************",
"scopes": ["iban-inquiry"]
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/auth/token', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/auth/token

ساختار ورودی

عنوان نوع اجباری توضیحات
username string بله نام کاربری درخواست کننده
password string بله رمز عبور درخواست کننده
secret_key string بله کلید واحدی که به هر کسب‌و‌کار تعلق دارد
scopes [string] خیر برای مشخص شدن سطح دسترسی

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

نکته : مقدار scopes در توضیحات API هر قسمت وجود دارد.

خروجی کد وضعیت 200

{
"token_type": "Bearer",
"expires_in": 1800,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
"refresh_token": "def502008c9703c9cd4b1b564111eb3dca340fc2f6e995aef4d005a8"
}

خروجی کد وضعیت 401

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

{
"message": "کلید وارد شده معتبر نمی باشد"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
401 عدم اعتبار‌سنجی

ساختار خروجی

عنوان نوع توضیحات
token_type string نوع توکن بازگشتی
expires_in number زمان انقضای توکن
access_token string توکن
refresh_token string توکن بازیابی

بازیابی توکن

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


curl -X POST https://jibimo.com/v2/auth/token/refresh\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d'{
"refresh_token": "def502005c9708c9cd4b1b564111eb3dca340fc2"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/v2/auth/token/refresh', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/v2/auth/token/refresh

ساختار ورودی

عنوان نوع اجباری توضیحات
refresh_token string بله توکن بازیابی

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

خروجی کد وضعیت 200

{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9",
"refresh_token": "def502008c9703c9cd4b1b564111eb3dca340fc2f6e995aef4d005a8"
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق

ساختار خروجی

عنوان نوع توضیحات
token_type string نوع توکن بازگشتی
expires_in number زمان انقضای توکن
access_token string توکن
refresh_token string توکن بازیابی

ایجاد گروه

با ارسال پارامتر‌های زیر به صورت POST می‌توانید عملیات ایجاد گروه را انجام دهید.


curl -X POST https://jibimo.com/batchPay/createBatch \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'\
-d'{
"title": "pardakh 13 aban",
"check": "noCheck",
"payAfterCheck": true
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/batchPay/createBatch', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/createBatch

ساختار ورودی

عنوان نوع اجباری توضیحات
title string بله نام گروه
check string true وضعیت پرداخت
payAfterCheck boolean بله به صورت پیش فرض true است اگر مقدار false داشته باشد پس از بررسی عملیات پرداخت را انجام نمی‌دهد

مقادیر وضعیت پرداخت (check)

عنوان توضیحات
noCheck در صورت افزودن آیتم به این گروه نیازی به بررسی وجود ندارد و آماده پرداخت است
checkAccountStatus در صورت افزودن آیتم به این گروه عملیات استعلام حساب انجام می‌شود و در صورتی که حساب موردی نداشته باشد پرداخت انجام خواهد شد
checkAccountAndNameFullMatching در صورت افزودن آیتم به این گروه عملیات استعلام حساب انجام می‌شود و در صورتی که مشخصات فرد با اطلاعات ورودی کاملا یکی باشد عملیات پرداخت انجام خواهد شد
checkAccountAndNamePartialMatching در صورت افزودن آیتم به این گروه عملیات استعلام حساب انجام می‌شود و در صورتی که مشخصات فرد با اطلاعات ورودی کاملا یکی هم نباشد عملیات پرداخت انجام خواهد شد

نکته : در وضعیت checkAccountAndNamePartialMatching تطابق 90 درصد به بالا پرداخت خواهد شد که در اینصورت عملیات دارای ریسک است.

نکته : در صورتی که payAfterCheck برابر true باشد و مقدار check برابر noCheck باشد هر آیتمی که به گروه اضافه شود بدون بررسی پرداخت می‌شود.

نکته : در صورتی که payAfterCheck برابر false باشد آیتم ها به گروه اضافه می‌شوند ولی عملیات پرداخت انجام نمی‌شود. در این حالت می توانید پس از ورود به پنل کاربری در بخش پرداخت گروهی از دکمه تاریخچه به تاریخچه پرداخت ها بروید و با انتخاب گروهی که ساخته‌اید آن گروه وارد بخش آماده سازی و پرداخت شود و با زدن دکمه پرداخت همه آیتم‌های مدنظر برای پرداخت ارسال شوند.

خروجی کد وضعیت 200

{
"id": 1233
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
403 عدم دسترسی

ساختار خروجی

عنوان توضیحات
id شناسه گروه ایجاد شده

افزودن آیتم به گروه

با ارسال پارامتر‌های زیر به صورت POST می‌توانید عملیات افزودن آیتم جدید به گروه را انجام دهید.


curl -X POST https://jibimo.com/api/business/iban/batchPay/addItem/{batchRequestId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'\
-d'{
[
{
"uuid": "d8167dd3-86bd-433e-8dc1-037f846f394d",
"id": "3",
"name": "محمد",
"family": "محمدی",
"amount": 12000,
"iban": "IR33017000****************",
"account": "838-***-******-*",
"bank_patten": "2503",
"additionalData1": "string",
"additionalData2": "string",
"additionalData3": "string"
}
]
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('POST','https://jibimo.com/api/business/iban/batchPay/addItem/{batchRequestId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/addItem/{batchRequestId}

نمونه‌ای از پارامتر ارسالی

[
{
"uuid": "d8167dd3-86bd-433e-8dc1-037f846f394d",
"id": "3",
"name": "محمد",
"family": "محمدی",
"amount": 12000,
"iban": "IR33017000****************",
"account": "838-***-******-*",
"bank_patten": "2503",
"additionalData1": "string",
"additionalData2": "string",
"additionalData3": "string"
}
]

ساختار ورودی

عنوان نوع اجباری توضیحات
batchRequestId integer(int64) بله شناسه گروه (این مقدار در آدرس باید تعیین شود)
uuid string بله شناسه منحصر به فرد
id integer(int64) بله شناسه آیتم
name string بله نام
family string بله نام خانوادگی
amount number بله مبلغ
iban string بله شماره شبا
account string بله شماره حساب
bank_patten string بله کد بانک یا نام بانک
additionalData1 string خیر توضیحات
additionalData2 string خیر توضیحات
additionalData3 string خیر توضیحات

نکته : batchRequestId را می‌توانید از مرحله ایجاد گروه دریافت کنید.

نکته : ورودی به صورت آرایه‌ای از موارد بالا است.

نکته : وجود یکی از موارد نام و یا نام خانوادگی اجباری است.

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

در فیلدهای additionalData می‌توانید اطلاعاتی مثل کدملی و یا سایر اطلاعاتی که دارای اهمیت هستند را ارسال کنید تا سیستم بعد از پرداخت این اطلاعات را برای شما برگرداند در اینصورت عملیات گزارش گیری و پیدا کردن داده‌ها راحت‌تر انجام می گیرد.

خروجی کد وضعیت 200

{
"batch_request_id": 1233,
"api_call_id": 1233
}

وضعیت پاسخ

عنوان توضیحات
200 عملیات موفق
403 عدم دسترسی

ساختار خروجی

عنوان نوع توضیحات
batch_request_id integer شناسه گروه
api_call_id integer شناسه اطلاعات ورودی

برای اطلاعات ورودی شما سیستم شناسه ای با نام api_call_id در نظر می‌گیرد. زمانی که نیاز به گزارش گیری باشد می‌توانید از این شناسه استفاده کنید و گزارش اطلاعات ارسالی را در این موارد بررسی کنید.

وضعیت آیتم‌های گروه با شناسه اطلاعات ورودی

باارسال پارامتر زیر به صورت GET می‌توانید وضعیت آیتم‌های یک گروه را از طریق api_call_id بررسی کنید.


curl -X GET https://jibimo.com/api/business/iban/batchPay/getItemsStatus/{apiCallId}{apiCallId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/api/business/iban/batchPay/getItemsStatus/{apiCallId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/getItemsStatus/{apiCallId}

ساختار ورودی

عنوان نوع اجباری توضیحات
apiCallId integer(int64) بله شناسه اطلاعات ورودی

خروجی کد وضعیت 200

[
{
"uuid": "d8167dd3-86bd-433e-8dc1-037f846f394d",
"id": "3",
"pay_item_id": 0,
"error_id": 0,
"name_original": "mohammad",
"family_original": "mohammadi",
"name_from_bank": "mohammad",
"family_from_bank": "mohammadi",
"account_number_from_bank": "123-32332-6",
"bank_name": "سامان",
"account_status_from_bank": "payable",
"matching_status": "match",
"pay_status": "wait",
"inquiry_status": "wait",
"bank_tracking_id": 1600149278002625,
"iban": "string",
"created_at": "1605075552",
"updated_at": "1605075552",
"amount": 12000,
"additionalData1": "string",
"additionalData2": "string",
"additionalData3": "string"
}
]

وضعیت پاسخ

عنوان توضیحات
200 عملیات موفق
403 عدم دسترسی
404 آدرس نامعتبر

ساختار خروجی

عنوان نوع توضیحات
uuid string شناسه منحصر به فرد
id integer(int64) شناسه
pay_item_id integer(int64) شناسه آیتم
error_id integer(int64) شناسه خطا
name_original string نام
family_original string نام خانوادگی
name_from_bank string نام استعلام شده
family_from_bank string نام خانوادگی استعلام شده
account_number_from_bank string شماره حساب
bank_name string نام بانک
account_status_from_bank string وضعیت حساب
matching_status string وضعیت تطابق
pay_status string وضعیت پرداخت
inquiry_status string وضعیت استعلام
bank_tracking_id string شماره پیگیری
iban string شماره شبا
amount number مبلغ
additionalData1 string توضیحات
additionalData2 string توضیحات
additionalData3 string توضیحات

مقادیر وضعیت حساب (account_status_from_bank)

عنوان توضیحات
payable قابل پرداخت
not-payable غیر قابل پرداخت

مقادیر وضعیت پرداخت (pay_status) و وضعیت استعلام (inquiry_status)

عنوان توضیحات
wait در انتظار
in-progress در حال انجام
fail ناموفق
cancel رد شده

مقادیر وضعیت تطابق (status)

وضعیت توضیحات
match تطابق کامل
partial_match تطابق نسبی
not_match عدم تطابق

لیست آیتم‌های گروه

با ارسال پارامتر‌های زیر به صورت GET می‌توانید لیست آیتم‌های یک گروه را دریافت کنید.


curl -X GET https://jibimo.com/api/business/iban/batchPay/items/{batchRequestId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/api/business/iban/batchPay/items/{batchRequestId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/items/{batchRequestId}

ساختار ورودی

عنوان نوع اجباری توضیحات
batchRequestId integer(int64) بله شناسه گروه (این مقدار در آدرس باید تعیین شود)
page number خیر شماره صفحه
per_page number خیر تعداد در صفحه

نکته : مقادیر page و per_page به صورت query string ارسال می‌شوند.

خروجی کد وضعیت 200

{
"data": [
{
"uuid": "d8167dd3-86bd-433e-8dc1-037f846f394d",
"id": "3",
"pay_item_id": 0,
"error_id": 0,
"name_original": "mohammad",
"family_original": "mohammadi",
"name_from_bank": "mohammad",
"family_from_bank": "mohammadi",
"account_number_from_bank": "123-32332-6",
"bank_name": "سامان",
"account_status_from_bank": "payable",
"matching_status": "match",
"pay_status": "wait",
"inquiry_status": "wait",
"bank_tracking_id": 1600149278002625,
"iban": "string",
"created_at": "1605075552",
"updated_at": "1605075552",
"amount": 12000,
"additionalData1": "string",
"additionalData2": "string",
"additionalData3": "string"
}
],
"links": {
"first": "http://jibimo.com/business/iban/batchPay/items/3?page=1",
"last": "http://jibimo.com/api/business/iban/batchPay/items/3?page=4",
"prev": "http://jibimo.com/api/business/iban/batchPay/items/3?page=1",
"next": "http://jibimo.com/api/business/iban/batchPay/items/3?page=3"
},
"meta": {
"current_page": 2,
"from": 10,
"last_page": 4,
"path": "http://jibimo.com/api/business/iban/batchPay/items/3",
"per_page": "5",
"to": 10,
"total": 12
}
}

وضعیت پاسخ

عنوان توضیحات
200 عملیات موفق
403 عدم دسترسی
404 آدرس نامعتبر

ساختار خروجی

عنوان نوع توضیحات
uuid string شناسه منحصر به فرد
id integer(int64) شناسه
pay_item_id integer(int64) شناسه آیتم
error_id integer(int64) شناسه خطا
name_original string نام
family_original string نام خانوادگی
name_from_bank string نام استعلام شده
family_from_bank string نام خانوادگی استعلام شده
account_number_from_bank string شماره حساب
bank_name string نام بانک
account_status_from_bank string وضعیت حساب
matching_status string وضعیت تطابق
pay_status string وضعیت پرداخت
inquiry_status string وضعیت استعلام
bank_tracking_id string شماره پیگیری
iban string شماره شبا
amount number مبلغ
additionalData1 string توضیحات
additionalData2 string توضیحات
additionalData3 string توضیحات

مقادیر وضعیت حساب (account_status_from_bank)

عنوان توضیحات
payable قابل پرداخت
not-payable غیر قابل پرداخت

مقادیر وضعیت پرداخت (pay_status) و وضعیت استعلام (inquiry_status)

عنوان توضیحات
wait در انتظار
in-progress در حال انجام
fail ناموفق
cancel رد شده

مقادیر وضعیت تطابق (status)

وضعیت توضیحات
match تطابق کامل
partial_match تطابق نسبی
not_match عدم تطابق

لیست گروه‌ها

با ارسال پارامتر‌های زیر به صورت GET می‌توانید لیست گروه‌ها را دریافت کنید.


curl -X GET https://jibimo.com/api/business/iban/batchPay/list \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/api/business/iban/batchPay/list', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/list

ساختار وردی

عنوان نوع اجباری توضیحات
title string خیر فیلتر گروه‌ها از طریق عنوان
page number خیر شماره صفحه
per_page number خیر تعداد در صفحه

نکته : مقادیر title و page و per_page به صورت query string ارسال می‌شوند.

خروجی کد وضعیت 200

[
{
"id": 56,
"title": "pardakh 13 aban",
"user": {
"username": "mohammad",
"name": "mohammad",
"family": "mohammadi"
},
"status": "wait",
"payAfterCheck": false,
"check_status": "noCheck",
"created_at": 1611577645,
"updated_at": 1611581043
}
]

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
403 عدم دسترسی

ساختار خروجی

عنوان نوع توضیحات
id integer(int64) شناسه
title string عنوان
user object اطلاعات کاربر
status string وضعیت
payAfterCheck boolean پرداخت پس از بررسی
check_status string وضعیت پرداخت

ساختار خروجی user

عنوان نوع توضیحات
username string نام کاربری
name string نام
family string نام خانوادگی

مقادیر وضعیت پرداخت (check_status)

عنوان توضیحات
noCheck آماده پرداخت
checkAccountStatus استعلام حساب انجام می‌شود و در صورتی که حساب موردی نداشته باشد پرداخت انجام خواهد شد
checkAccountAndNameFullMatching استعلام حساب انجام می‌شود و در صورتی که مشخصات فرد با اطلاعات ورودی کاملا یکی باشد عملیات پرداخت انجام خواهد شد
checkAccountAndNamePartialMatching استعلام حساب انجام می‌شود و در صورتی که مشخصات فرد با اطلاعات ورودی کاملا یکی هم نباشد عملیات پرداخت انجام خواهد شد

مقادیر وضعیت (status)

عنوان توضیحات
wait در انتظار
preparing در حال آماده سازی
in-progress در حال انجام
ready آماده
finish پایان یافته
cancel رد شده

وضعیت یک آیتم

با ارسال پارامتر‌های زیر به صورت GET می‌توانید وضعیت یک آیتم را بررسی کنید.


curl -X GET https://jibimo.com/api/business/iban/batchPay/item/status?pay_item_id=2\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/api/business/iban/batchPay/item/status?pay_item_id=2', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/item/status

ساختار ورودی

عنوان نوع اجباری توضیحات
pay_item_id number خیر شناسه آیتم
pay_item_uuid string خیر شناسه منحصر به فرد آیتم

نکته : مقادیر pay_item_id و pay_item_uuid به صورت query string ارسال می‌شوند.

نکته : وجود یکی از موارد pay_item_id و یا pay_item_uuid اجباری است.

خروجی کد وضعیت 200

[
{
"uuid": "d8167dd3-86bd-433e-8dc1-037f846f394d",
"id": "user identifier for data(radif)",
"pay_item_id": 0,
"error_id": 0,
"name_original": "mohammad",
"family_original": "mohammadi",
"name_from_bank": "mohammad",
"family_from_bank": "mohammadi",
"account_number_from_bank": "123-32332-6",
"bank_name": "سامان",
"account_status_from_bank": "payable",
"matching_status": "match",
"pay_status": "wait",
"inquiry_status": "wait",
"bank_tracking_id": 1600149278002625,
"iban": "string",
"created_at": "1605075552",
"updated_at": "1605075552",
"amount": 12000,
"additionalData1": "string",
"additionalData2": "string",
"additionalData3": "string",
"histories": [
{
"id": 452,
"event": "item_inquiry",
"batch_request_id": 685,
"pay_item_id": 685,
"user": {
"username": "mohammad",
"name": "mohammad",
"family": "mohammadi"
},
"description": ".استعلام آیتم انجام شد",
"data": "",
"created_at": "1605075552",
"updated_at": "1605075552"
}
]
}
]

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
403 عدم دسترسی
404 آدرس نامعتبر

ساختار خروجی

عنوان نوع توضیحات
uuid string شناسه منحصر به فرد
id integer(int64) شناسه
pay_item_id integer(int64) شناسه آیتم
error_id integer(int64) شناسه خطا
name_original string نام
family_original string نام خانوادگی
name_from_bank string نام استعلام شده
family_from_bank string نام خانوادگی استعلام شده
account_number_from_bank string شماره حساب
bank_name string نام بانک
account_status_from_bank string وضعیت حساب
matching_status string وضعیت تطابق
pay_status string وضعیت پرداخت
inquiry_status string وضعیت استعلام
bank_tracking_id string شماره پیگیری
iban string شماره شبا
amount number مبلغ
additionalData1 string توضیحات
additionalData2 string توضیحات
additionalData3 string توضیحات
histories [object] تاریخچه

ساختار خروجی histories

عنوان نوع توضیحات
id integer(int64) شناسه
event string نام رویداد
batch_request_id integer(int64) شناسه گروه
pay_item_id integer(int64) شناسه آیتم
user object اطلاعات کاربری
description string توضیحات
data string اطلاعات وارد شده

ساختار خروجی user

عنوان نوع توضیحات
username string نام کاربری
name string نام
family string نام خانوادگی

مقادیر وضعیت حساب (account_status_from_bank)

عنوان توضیحات
payable قابل پرداخت
not-payable غیر قابل پرداخت

مقادیر وضعیت پرداخت (pay_status) و وضعیت استعلام (inquiry_status)

عنوان توضیحات
wait در انتظار
in-progress در حال انجام
fail ناموفق
cancel رد شده

مقادیر وضعیت تطابق (status)

وضعیت توضیحات
match تطابق کامل
partial_match تطابق نسبی
not_match عدم تطابق

به روز رسانی یک آیتم

با ارسال پارامتر‌های زیر به صورت PATCH می‌توانید یک آیتم را به روز رسانی کنید.


curl -X PATCH https://jibimo.com/api/business/iban/batchPay/update/item\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian' \
-d '{
"pay_item_id": 3,
"iban": "IR330170000000200150094006"
}'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('PATCH','https://jibimo.com/api/business/iban/batchPay/update/item', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/update/item

ساختار ورودی

عنوان نوع اجباری توضیحات
pay_item_id number خیر شناسه آیتم
pay_item_uuid string خیر شناسه منحصر به فرد آیتم
iban string بله شماره شبا

نکته : وجود یکی از موارد pay_item_id و یا pay_item_uuid اجباری است.

خروجی کد وضعیت 200

{
"result": {
"batch_item": [
{
"uuid": "d8167dd3-86bd-433e-8dc1-037f846f394d",
"id": "user identifier for data(radif)",
"pay_item_id": 0,
"error_id": 0,
"name_original": "mohammad",
"family_original": "mohammadi",
"name_from_bank": "mohammad",
"family_from_bank": "mohammadi",
"account_number_from_bank": "123-32332-6",
"bank_name": "سامان",
"account_status_from_bank": "payable",
"matching_status": "match",
"pay_status": "wait",
"inquiry_status": "wait",
"bank_tracking_id": 1600149278002625,
"iban": "string",
"created_at": "1605075552",
"updated_at": "1605075552",
"amount": 12000,
"additionalData1": "string",
"additionalData2": "string",
"additionalData3": "string"
}
],
"editor": {
"username": "mohammad",
"name": "mohammad",
"family": "mohammadi"
}
},
"message": "درخواست شما با موفقیت انجام شد.",
"status": true,
"errors": [
""
]
}

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
403 عدم دسترسی
404 آدرس نامعتبر

ساختار خروجی

عنوان نوع توضیحات
batch_item [object] اطلاعات گروه
editor object اطلاعات ویرایش کننده

ساختار خروجی batch_item

عنوان نوع توضیحات
uuid string شناسه منحصر به فرد
id integer(int64) شناسه
pay_item_id integer(int64) شناسه آیتم
error_id integer(int64) شناسه خطا
name_original string نام
family_original string نام خانوادگی
name_from_bank string نام استعلام شده
family_from_bank string نام خانوادگی استعلام شده
account_number_from_bank string شماره حساب
bank_name string نام بانک
account_status_from_bank string وضعیت حساب
matching_status string وضعیت تطابق
pay_status string وضعیت پرداخت
inquiry_status string وضعیت استعلام
bank_tracking_id string شماره پیگیری
iban string شماره شبا
amount number مبلغ
additionalData1 string توضیحات
additionalData2 string توضیحات
additionalData3 string توضیحات
histories [object] تاریخچه

ساختار خروجی editor

عنوان نوع توضیحات
username string نام کاربری
name string نام
family string نام خانوادگی

مقادیر وضعیت حساب (account_status_from_bank)

عنوان توضیحات
payable قابل پرداخت
not-payable غیر قابل پرداخت

مقادیر وضعیت پرداخت (pay_status) و وضعیت استعلام (inquiry_status)

عنوان توضیحات
wait در انتظار
in-progress در حال انجام
fail ناموفق
cancel رد شده

مقادیر وضعیت تطابق (status)

وضعیت توضیحات
match تطابق کامل
partial_match تطابق نسبی
not_match عدم تطابق

گزارش گیری از گروها

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


curl -X GET https://jibimo.com/api/business/iban/batchPay/report/inputOutpu?from=1399-12-26&to=1399-12-30\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/api/business/iban/batchPay/report/inputOutpu?from=1399-12-26&to=1399-12-30', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/report/inputOutput

ساختار ورودی

عنوان نوع اجباری توضیحات
from string بله تاریخ شروع(فرمت فارسی 26-12-1399)
to string بله تاریخ پایان(فرمت فارسی 26-12-1399)

نکته : مقادیر from و to به صورت query string ارسال می‌شوند.

خروجی کد وضعیت 200

[
{
"id": 56,
"uuid": "d8167dd3-86bd-433e-8dc1-037f846f394d",
"name": "محمد",
"family": "محمدی",
"iban": "190320020000008765401914",
"amount": "26.666666666666668",
"batch_id": 125,
"batch_name": "string",
"is_edit": 0,
"error_id": 0,
"status": "wait",
"created_at": 1611577645,
"updated_at": 1611581043,
"withdrawals": [
{
"id": 56,
"tracker_id": "string",
"success_date": "string",
"reject_date": "string",
"status": "Accepted",
"bank": "saman",
"iban": "190320020000008765401914",
"amount": "26.666666666666668",
"created_at": 1611577645,
"updated_at": 1611581043
}
]
}
]

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
403 خطای دسترسی

ساختار خروجی

عنوان نوع توضیحات
uuid string شناسه منحصر به فرد
id integer(int64) شناسه
name string نام
family string نام خانوادگی
iban string شماره شبا
amount number مبلغ
batch_id number شناسه گروه
batch_name string نام گروه
is_edit boolean ویرایش شده
status string وضعیت
error_id number شناسه خطا
withdrawals [object] برداشت‌ها

ساختار خروجی withdrawals

عنوان نوع توضیحات
id integer(int64) شناسه
tracker_id string شماره پیگیری
success_date string تاریخ پرداخت موفق
reject_date string تاریخ رد شدن
status string وضعیت
bank string نام بانک
iban string شماره شبا
amount string مبلغ

مقادیر وضعیت (status)

عنوان توضیحات
wait در انتظار
preparing در حال آماده سازی
in-progress در حال انجام
ready آماده
finish پایان یافته
cancel رد شده

مقادیر وضعیت (status) در withdrawals

عنوان توضیحات
Pending در انتظار
Accepted تائید شده
Retrying تلاش مجدد
Rejected رد شده

لیست خطاها

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


curl -X GET https://jibimo.com/api/business/iban/batchPay/errors \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian'
<?php

require 'vendor/autoload.php';

$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIyIiwian',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
$response = $client->request('GET','https://jibimo.com/api/business/iban/batchPay/errors', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}


https://jibimo.com/api/business/iban/batchPay/errors

خروجی کد وضعیت 200

[
{
"id": 1233,
"name": "ConvertedIbanNotValid",
"code": "101",
"description": " شبای تبدیل شده معتبر نیست",
"category": "conversion"
}
]

وضعیت پاسخ

کد وضعیت توضیحات
200 عملیات موفق
403 عدم دسترسی

ساختار خروجی

عنوان نوع توضیحات
id number شناسه
name string نام
code string کد خطا
description string توضیحات
category string دسته بندی خطا

لیست کد بانک‌ها

مقادیر کد بانک

عنوان کد فرمت شماره حساب پشتیبانی می‌شود
ملی 017 xxxxxxxxxxxxx بله
سپه 015 xxxxxxxxxxx , xxxxxxxxxxxx , xxxxxxxxxxxxx بله
توسعه صادرات 020 xxxxxxxxxxxxx بله
صنعت و معدن 011 xxxxxxxxxxxxx بله
کشاورزی 016 xxxxxxxx , xxxxxxxxx بله
مسکن 014 xxxxxxxxxxx , xxxxxxxxxxxx , xxxxxxxxxxxxx بله
پست بانک 021 xxxxxxxxxxxxx , xxxxxxxxxxxxxx خیر
توسعه تعاون 022 xxxx.xxx.xxxxxx.x , xxxx.xxx.xxxxxxx.x بله
اقتصاد نوین 055 xxx-xxx-xxxxxxx-x , xxxx-xxx-xxxxxxx-x , xxxx-x-xxxxxxx-x بله
پارسیان 054 xxxxxxxxxxxxxx خیر
پاسارگاد 057 xxx.xxx.xxxxxx.x , xxx.xxxx.xxxxxx.x , xxx.xxx.xxxxx.x , xxx.xxx.xxxxxxx.x , xxx.xxxx.xxxxxxx.x , xxx.xxxx.xxxxxxxx.x , xxxx.xxx.xxxxxxxx.x , xxxx.xxxx.xxxxxxxx.x بله
کارآفرین 053 xxxxxxxxxxxxx بله
سامان 056 xxx-xxx-xxxxx-x , xxx-xxx-xxxxxx-x , xxx-xx-xxxxx-x , xxx-xxx-xxxxxxx-x , xxxx-xxx-xxxxxx-x , xxx-xxx-xxxxxxxx-x , xxxx-xxx-xxxxxxx-x بله
سینا 059 xxx-xx-xxxxxxx-x , xxx-xxx-xxxx-x , xxx-xxx-xxxxxxx-x بله
سرمایه 058 xxxx-xxx-xxxxxx-x بله
آینده 062 xxxxxxxxxxxx , xxxxxxxxxxxxx بله
شهر 061 xxxxxxxxxxxx , xxxxxxxxxxxxx بله
دی 066 xxxxxxxxxxxxx بله
صادرات 019 xxxxxxxxxxxxx بله
رفاه 013 xxxxxxxx , xxxxxxxxx بله
ملت 012 xxxxxxxx , xxxxxxxxx , xxxxxxxxxx بله
تجارت 018 xxxxxxxxxxxxx بله
ایران زمین 069 xxxx-xxx-xxxxxx-x بله
گردشگری 064 xxx.xxxx.xxxxxx.x , xxxx.xxxx.xxxxxx.x بله
انصار 063 xxxx-xx-xxxxxx-x , xxxx-xx-xxxxxxx-x , xxxx-xx-xxxxxxxx-x , xxxx-xxx-xxxxxxx-x , xxxx-xxx-xxxxxxx-xx , xxxx-xxx-xxxxxxxx-x بله
حکمت ایرانیان 065 xxx-xxx-xxxxxxx-x , xxxx-xx-xxxxxxx-x بله
قرض الحسنه مهر ایران 060 xxxx-xx-xxxxxx-x , xxxx-xx-xxxxxxx-x , xxxx-xxx-xxxxxxx-x بله
قوامین 052 xxxxxxxxxxxxxxx خیر
موسسه اعتباری توسعه 051 xxx-xxx-xxxxxx-xx , xxx-xxx-xxxxx-xx , xxx-xxx-xxxx-xx , xxx-xxx-xxx-xx , xxx-xxx-xx-xx , xxx-xxx-x-xx , xxxx-xxx-xxxxxx-xx , xxxx-xxx-xxxxx-xx , xxxx-xxx-xxxx-xx , xxxx-xxx-xxx-xx , xxxx-xxx-xx-xx , xxxx-xxx-x-xx بله
خاورمیانه 078 xxxx-xx-xxx-xxxxxxxxx بله
قرض الحسنه رسالت 070 xx.xxxxxx.x , xx.xxxxxxx.x , xxx.xxxxxxx.x بله
موسسه اعتباری کوثر 073 xxxxxxxxxxxxxx , xxxxxxxxxxxxx خیر
موسسه اعتباری نور 080 xxxxxxxxxxxxx بله
موسسه اعتباری ملل 075 xxxxxxxxxxxxxxxxxx بله
ایران ونزوئلا 095 xxxxxxxxxx خیر
مرکزی 010 xxxxxxxxxxxxxxxx خیر