API پرداخت کرایه تاکسی (پرداخت)
در مقاله های قبل در مورد مقدمه وب سرویس پرداخت کرایه تاکسی و متدهای پذیرنده این وب سرویس صحبت کردیم در این مقابه در مورد وب سرویس پرداخت کرایه تاکسی (پرداخت) صحبت خواهیم کرد.
ساختن درخواست پرداخت
با استفاده از این سرویس یک درخواست پرداخت ساخته شده و توکنی برای شروع پرداخت بازگردانده می‌شود.
درخواست HTTP
POST https://resid.ir/api/v1/payments
پارامترهای ورودی
| پارامتر | نوع | ضروری | مقدار پیش‌فرض | توضیحات |
| amount | int | بله | – | مبلغ درخواست پرداخت |
| merchant | str | بله | – | شناسه‌ی پذیرنده |
| description | str | خیر | “ | توضیحات درخواست پرداخت |
| payload | str | خیر | ” | اطلاعات اضافی برای بازگردانده شدن در مراحل بعدی |
| auto_collect | bool | خیر | false | جمع‌آوری خودکار پرداخت‌های موفق انجام شده در بانک |
| preferred_method | string | خیر | “ | درگاه بانکی مورد ترجیح |
curl “https://resid.ir/api/v1/payments”
-H “Authorization: $AUTHROIZATION_CODE”
-d merchant=”faSDF42w3Fs”
-d amount=10000
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
{
“message”: “OK”,
“info”: {
“token”: “AsF42Sg53”
},
“errors”: []
}
نهایی‌سازی پرداخت
پس از دریافت نتیجه‌ی پرداخت از کلاینت، در صورتی که همچنان قصد ارائه محصول/خدمت به کاربر هستید با صدا کردن این سرویس میتوانید از نتیجه‌ی پرداخت مطلع شوید. توجه داشته باشید که نتیجه‌ی پرداخت ممکن است موفق، یا ناموفق بوده باشد. در صورتی که این سرویس در مدت زمان ۲۰ دقیقه از ساخته شدن درخواست پرداخت فراخوانی نشود و تراکنش موفق بوده باشد، به صورت خودکار پول به حساب کاربر بازگردانده می‌شود.
درخواست HTTP
POST https://resid.ir/api/v1/payments/<payment_request_token>/collect
پارامترهای URL
| پارامتر | نوع | ضروری | مقدار پیش‌فرض | توضیحات |
| payment_request_token | str | بله | – | شناسه‌ی پرداخت گرفته شده در مرحله‌ی شروع |
curl “https://resid.ir/api/v1/payments/AsF42Sg53/collect”
-H “Authorization: $AUTHROIZATION_CODE”
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
{
“message”: “OK”,
“info”: {},
“errors”: []
}
گرفتن اطلاعات پرداخت
با استفاده از توکن پرداخت شما میتوانید اطلاعات پرداخت را توسط این سرویس دریافت کنید.
درخواست HTTP
GET https://resid.ir/api/v1/payments/<payment_request_token>
پارامترهای URL
| پارامتر | نوع | ضروری | مقدار پیش‌فرض | توضیحات |
| payment_request_token | str | بله | – | شناسه‌ی پرداخت گرفته شده در مرحله‌ی شروع |
curl “https://resid.ir/api/v1/payments/AsF42Sg53”
-H “Authorization: $AUTHROIZATION_CODE”
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
“message”: “OK”,
“info”: {
“merchant”: {
“display_name”: “”,
“display_image”: “”,
“display_biz_name”: “”,
},
“description”: “”,
“payer”: “0938*****25”,
“created”: “2017-05-14T14:01:50.632640+04:30”,
“amount”: 10000,
“paid”: null,
“token”: “AsF42Sg53”,
“outcome”: {
“rrn”: “bank_reference_code”,
“total_amount”: 10000,
“tip”: 0,
“state”: “pending”,
“state_error”: null,
“method”: “asanpardakht”
},
“payload”: “”
},
“errors”: []
}
گرفتن لیست پرداخت‌ها
برای گرفتن لیست پرداخت‌های خود میتوانید از این سرویس استفاده کنید. توجه داشته باشید که لیست پرداخت‌های ناموفق نیز توسط این سرویس بازگردانده می‌شود. استفاده از این سرویس تنها باید با هدف گزارش‌گیری انجام شود و محدودیت تعداد فراخوانی در بازه‌ی زمانی بر روی این سرویس اعمال می‌گردد.
درخواست HTTP
GET https://resid.ir/api/v1/payments
پارامترهای ورودی
| پارامتر | نوع | ضروری | مقدار پیش‌فرض | توضیحات |
| size | int | خیر | ۵۰ | تعداد پرداخت‌ها در جواب. حداکثر مقدار مجاز برای این فیلد ۲۰۰ عدد می‌باشد. |
| before | iso datetime | خیر | زمان اکنون | پرداخت‌هایی که قبل از این زمان ساخته شده باشند برگردانده می‌شود. مقدار این فیلد باید در فرمت ISO-8601 بوده و به صورت UTC باشد. |
| after | iso datetime | خیر | – | در صورتی که بخواهید پرداخت‌هایی که بعد از یک زمان مشخص اتفاق افتاده‌اند را دریافت کنید باید به جای فیلد before از این فیلد استفاده کنید.. |
curl “https://resid.ir/api/v1/payments?after=2017-05-09T00:28:51.309004Z&size=1”
-H “Authorization: $AUTHROIZATION_CODE”
دستور بالا JSON با ساختار زیر بازمی‌گرداند:
{
“message”: “OK”,
“info”: [
{
“merchant”: {
“display_name”: “”,
“display_image”: “”,
“display_biz_name”: “”,
},
“description”: “”,
“payer”: “0938*****25”,
“created”: “2017-05-14T14:01:50.632640+04:30”,
“amount”: 10000,
“paid”: null,
“token”: “AsF42Sg53”,
“outcome”: {
“rrn”: “bank_reference_code”,
“total_amount”: 10000,
“tip”: 0,
“state”: “pending”,
“state_error”: null,
“method”: “asanpardakht”
},
“payload”: “”
}
],
“errors”: []
}
برای دریافت کامل راهنمای این وب سرویس میتوانید از این لینک اقدام کنید