مستندات API – سرویس تبدیل شماره کارت به شبا
مستندات سرویس API تبدیل شماره کارت به شماره شبا
Card Inquiry API Documents
نسخه 1.1.0 - 11/28/2023
فهرست مطالب
۱. مقدمه
در سرویس تبدیل شماره کارت به شماره شبا یوآیدی، با ارسال شماره کارت کاربر، می‌توانید شماره شبای کاربر را دریافت کنید.
۲. فراخوانی سرویس inquiry/card
برای استفاده از سرویس API تبدیل شماره کارت به شماره شبا یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت شماره کارت کاربر، شماره شبای کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
https://json-api.uid.ir/api/inquiry/card
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo": {
"businessId": <UID_BUSINESS_ID>,
"businessToken": <UID_BUSINESS_TOKEN>
}
},
"cardNumber" : "1234123412341234"
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
cardNumber | string | Required | شماره کارت کاربر |
۳.۲. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"cardNumber": "1234123412341234",
"iban": "IR123456789012345678901234" // String - 26 Digits with IR
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| code | int | کد خطا |
| message | string | توضیحات خطا |
cardNumber | string | شماره کارت کاربر |
iban | string | شماره شبای کاربر |