API پرداخت کرایه تاکسی (پذیرنده)
در مقاله قبل در مورد مقدمه وب سرویس پرداخت کرایه تاکسی صحبت کردیم این مقاله در مورد وب سرویس پرداخت کرایه تاکسی (پذیرنده) صحبت خواهیم کرد.
پذیرنده
پذیرنده موجودی است که شماره شبا دارد و شما می‌توانید برای آن درخواست پرداخت بسازید. در صورتی که تنها از یک پذیرنده می‌خواهید استفاده کنید می‌توانید از این بخش عبور کنید.
ایجاد یک پذیرنده جدید
برای اینکه به شبایی درخواست پرداخت بدهید باید یک‌بار برای آن شبا پذیرنده‌ای در رسید ثبت کنید. با استفاده از این سرویس می‌توان یک پذیرنده جدید ثبت کرد.
درخواست HTTP
POST https://resid.ir/api/v1/merchants
| توضیحات | مقدار پیش‌فرض | ضروری | نوع | پارامتر |
| نام | – | بله | str | first_name |
| نام خانوادگی | – | بله | str | last_name |
| شماره تلفن | – | بله | str | phone_number |
| کد ملی | – | بله | str | national_no |
| شماره شبا | – | بله | str | sheba |
| کد بانک مربوطه | – | بله | int | bank_code |
| عنوان شغلی | “ | خیر | str | job_title |
| عکس پروفایل | null | خیر | image | logo |
curl “https://resid.ir/api/v1/merchants” \
-X POST \
-H “Authorization: $AUTHORIZATION_CODE” \
-F logo=”@/path/to/logo” \
-d first_name=”Asghar” \
-d last_name=”Farhadi” \
-d phone_number=”09123456789″ \
-d national_no=”1234567890″ \
-d sheba=”IR123456789012345678901234″ \
-d bank_code=0 \
-d job_title=”Programmer”
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
{
“message”: “OK”,
“info”: {
“first_name” : “Asghar”,
“last_name” : “Farhadi”,
“phone_number” : “09123456789”,
“national_no” : “1234567890”,
“sheba” : “IR123456789012345678901234”,
“job_title” : “Programmer”,
“slug” : “aF1q2FSde2R”,
“id_card” : “link/to/id_card”,
“logo” : “link/to/logo”,
“state” : “A”
},
“errors”: []
}
دریافت اطلاعات یک پذیرنده
با استفاده از این سرویس می‌توان اطلاعات یک پذیرنده‌ی ثبت شده را بدست آورد.
درخواست HTTP
GET https://resid.ir/api/v1/merchants/<merchant_slug>
پارامتر‌های URL
| پارامتر | توضیحات |
| merchant_slug | شناسه پذیرنده |
curl “https://resid.ir/api/v1/merchants/aF1q2FSde2R” \
-X GET \
-H “Authorization: $AUTHORIZATION_CODE”
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
{
“message”: “OK”,
“info”: {
“first_name” : “Asghar”,
“last_name” : “Farhadi”,
“phone_number” : “09123456789”,
“national_no” : “1234567890”,
“sheba” : “IR123456789012345678901234”,
“job_title” : “Programmer”,
“slug” : “aF1q2FSde2R”,
“id_card” : “link/to/id_card”,
“logo” : “link/to/logo”,
“state” : “A”
},
“errors”: []
}
به روزرسانی اطلاعات یک پذیرنده
با استفاده از این سرویس می‌توان اطلاعات یک پذیرنده‌ی ثبت شده را به روزرسانی کرد.
درخواست HTTP
PATCH https://resid.ir/api/v1/merchants/<merchant_slug>
پارامتر‌های URL
| پارامتر | توضیحات |
| merchant_slug | شناسه پذیرنده |
پارامتر‌های ورودی
| پارامتر | نوع | ضروری | مقدار پیش‌فرض | توضیحات |
| first_name | str | خیر | – | نام |
| last_name | str | خیر | – | نام خانوادگی |
| phone_number | str | خیر | – | شماره تلفن |
| national_no | str | خیر | – | کد ملی |
| job_title | str | خیر | ” | عنوان شغلی |
| logo | image | خیر | null | عکس پروفایل |
curl “https://resid.ir/api/v1/merchants/aF1q2FSde2R” \
-X PATCH \
-H “Authorization: $AUTHORIZATION_CODE” \
-d first_name=”Asqar” \
-d last_name=”Farhady” \
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
{
“message”: “OK”,
“info”: {},
“errors”: []
}
حذف پذیرنده
با استفاده از این سرویس می‌توان یک پذیرنده‌ی ثبت شده را حذف نمود.
درخواست HTTP
DELETE https://resid.ir/api/v1/merchants/<merchant_slug>
پارامتر‌های URL
| پارامتر | توضیحات |
| merchant_slug | شناسه پذیرنده |
curl “https://resid.ir/api/v1/merchants/aF1q2FSde2R” \
-X DELETE \
-H “Authorization: $AUTHORIZATION_CODE”
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
{
“message”: “OK”,
“info”: {},
“errors”: []
}
دریافت لیست پذیرنده‌ها
این سرویس لیست پذیرنده‌های ثبت شده توسط کسب و کار را نمایش می‌دهد.
درخواست HTTP
GET https://resid.ir/api/v1/merchants
پارامتر‌های URL
| پارامتر | توضیحات |
| offset | میزان آفست از ابتدای لیست |
| size | اندازه بازه درخواستی |
curl “https://resid.ir/api/v1/merchants?offset=20&size=10” \
-X GET \
-H “Authorization: $AUTHORIZATION_CODE”
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
[
{
“message”: “OK”,
“info”: {
“first_name” : “Asghar”,
“last_name” : “Farhadi”,
“phone_number” : “09123456789”,
“national_no” : “1234567890”,
“sheba” : “IR123456789012345678901234”,
“job_title” : “Programmer”,
“slug” : “aF1q2FSde2R”,
“id_card” : “link/to/id_card”,
“logo” : “link/to/logo”,
“state” : “A”
},
“errors”: []
}
{…},
{…}
]
در این مقاله در مورد وب سرویس پرداخت کرایه تاکسی (پذیرنده) صحبت کردیم در مقاله بعد در مورد وب سرویس پرداخت کرایه تاکسی (پرداخت) صحبت خواهیم کرد