مستندات سرویس API تبدیل شماره حساب به شبا
Account To Iban API Documents
نسخه 1.0.0 - 04/12/2025
فهرست مطالب
۱. مقدمه
در سرویس تبدیل شماره حساب به شبا یوآیدی، با ارسال شماره حساب کاربر و نام بانک، شماره شبا را در خروجی نمایش میدهد.
۲. فراخوانی سرویس account-to-iban
برای استفاده از سرویس API یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت شماره حساب کاربر و نام بانک، شماره شبای مربوط به حساب را نمایش میدهد.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/account-to-iban
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo" : {
"businessId" : <UID_BUSINESS_ID>,
"businessToken" : <UID_BUSINESS_TOKEN>
}
},
"accountNumber" : "0123456789",
"bank" : "BANK_NAME or BANK_CODE"
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| accountNumber | string | Required | شماره حساب |
| bank | string | Required | نام یا کد بانک |
۳.۲. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"iban": "IR810170000000000000000000"
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| iban | string | شماره شبای مربوط به حساب |
| code | int | کد خطا |
| message | string | توضیحات خطا |
۴.۳. نام بانک
| Bank | Code |
| BANK_DEY | 66 |
| BANK_SEPAH | 15 |
| BANK_SHAHR | 61 |
| BANK_MELAT | 12 |
| BANK_MELLI | 17 |
| BANK_REFAH | 13 |
| BANK_SINA | 59 |
| BANK_MASKAN | 14 |
| BANK_AYANDEH | 62 |
| BANK_ANSAR | 63 |
| BANK_TEJARAT | 18 |
| BANK_RESALAT | 70 |
| BANK_SAMAN | 56 |
| BANK_MARKAZI | 10 |
| BANK_SARMAYEH | 58 |
| BANK_SADERAT | 19 |
| BANK_GHAVAMIN | 52 |
| BANK_PARSIAN | 54 |
| BANK_KESHAVARZI | 16 |
| BANK_GARDESHGARI | 64 |
| BANK_POST_BANK | 21 |
| BANK_PASARGAD | 57 |
| BANK_KARAFARIN | 53 |
| BANK_KHAVARMIANEH | 78 |
| BANK_IRAN_ZAMIN | 69 |
| BANK_MEHR_EQTESAD | 79 |
| BANK_SANAT_MADAN | 11 |
| BANK_EGHTESAD_NOVIN | 55 |
| BANK_TOSSE_TAAVON | 22 |
| BANK_TOSSE_SADERAT | 20 |
| BANK_IRAN_VENEZUELA | 95 |
| BANK_HEKMAT_IRANIAN | 65 |
| BANK_GHARZOLHASANEH_MEHR | 60 |
| BANK_MOASSASE_MELLAL | 75 |
| BANK_MOASSASE_NOOR | 80 |
| BANK_MOASSASE_KOSAR | 73 |
| BANK_MOASSASE_TOSSE | 51 |
