مستندات سرویس API اسعتلام اطلاعات مالی (شماره شبا یا IBAN)
IBAN (Sheba) Inquiry API Documents
نسخه 1.1.0 - 08/20/2023
فهرست مطالب
۱. مقدمه
در سرویس استعلام اطلاعات مالی (شماره شبا یا IBAN) یوآیدی، با ارسال شماره شبای کاربر، می‌توانید استعلام اطلاعات مالی مربوط به صاحب حساب را دریافت نمائید.
۲. فراخوانی سرویس inquiry/iban/v2
برای استفاده از سرویس API استعلام اطلاعات مالی (شماره شبا یا IBAN) یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت شماره شبای کاربر، اطلاعات مالی کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/inquiry/iban/v2
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo" : {
"businessId" : <UID_BUSINESS_ID>,
"businessToken" : <UID_BUSINESS_TOKEN>
}
},
"iban" : "IR123456789012345678901234" // String - 26 Digits with IR
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| iban | string | Required | شماره شبای کاربر |
۳.۲. نمونه پاسخ
{
"accountBasicInformation": {
"iban": <IBAN_NUMBER>,
"accountNumber": <ACCOUNT_NUMBER>,
"bankInformation": {
"bankName": <BANK_NAME>
},
"accountStatus": <ACCOUNT_STATUS>,
"owners": [
{
"firstName": <FIRST_NAME>,
"lastName": <LAST_NAME>,
"nationalIdentifier": <NATIONAL_IDENTIFIER>,
"customerType": <CUSTOMER_TYPE>
}
],
// More Response Details:
"responseContext": {
"status": {
"code": 0,
"message": "",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
}
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
iban | string | شماره شبای کاربر (مثال: IR123456789012345678901234) |
accountNumber | string | شماره حساب کاربر |
bankName | string | نام بانک |
accountStatus | string | ENUM | وضعیت حساب کاربر حساب فعال: ACCOUNT_STATUS_ACTIVE |
firstName | string | نام صاحب حساب |
lastName | string | نام خانوادگی صاحب حساب |
nationalIdentifier | string | کد ملی صاحب حساب (معمولا مقدار ندارد) |
customerType | string | ENUM | نوع مشتری (معمولا: CUSTOMER_TYPE_UNKNOWN) |
توجه: همانطور که در نمونه بالا مشخص است، یک حساب ممکن است دارای چند صاحب حساب باشد (حساب‌های مشترک و …) و اطلاعات صاحب(ان) حساب در یک آرایه با عنوان owners برگردانده می‌شود. در صورتی که حساب دارای یک صاحب حساب باشد، آرایه فوق تک عضوی خواهد بود.
