رویه استرداد آیتم خریداری شده – Refund Procedure

• دریافت رویه استرداد آیتم از طریق API
• سربرگ – Header
• مقادیر ارسالی – Request Data
• پاسخ صحیح – Response True
• پاسخ نادرست – Response False

دریافت رویه استرداد آیتم از طریق API

عنوان	وضعیت	مقادیر	توضیحات
Method	اجباری	GET	متد ارسال درخواست
Domain	اجباری	نام دامنه ثبت شده در اتوماسیون
Api Url	اجباری	دامنه هسته مرکزی سرویس
Api version	اجباری	به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.
Authorization	اجباری	توکن JWT تولید شده	این توکن بصورت JWT تولید میشود.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

سربرگ – Header

{{Api Url}}/refund/procedure

HEADER
GET /api/reservation/{{Api version}}/refund/procedure HTTP/1.1
Host: {{Your Host}}
Content-Type: application/json
Authorization: Bearer JWTToken
Domain: {{Your Domain}}

API Url از طریق پنل کاربری قابل مشاهده خواهد بود.

مقادیر ارسالی – Request Data

عنوان	نوع	وضعیت	مقادیر	توضیحات
reserve_id	String	اجباری	آیدی یا pnr اصلی

{
    "reserve_id": "" // id or pnr
}

پاسخ صحیح – Response True

عنوان	نوع	مقادیر	توضیحات
payload
payload.refundable	Boolean	true/false	اگر قوانین استرداد برای آیتم مورد نظر تعریف شده باشد مقدار این کلید true خواهد بود و اگرم تعریف نشده باشد مقدار این کلید false خواهد بود.
payload.reserve_id	Integer
payload.diffrance	Integer
payload.price	Integer	مقدار قیمت پرداختی
payload.penalty	Integer	مقدار جریمه پرداختی	هنگامی که مقدار کلید payload.refundable trueباشد این کلید وجود دارد
meta
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

دریافت این پاسخ با Status Code 200 دریافت خواهد شد.

 {
    "payload": {
        "refundable": true,
        "reserve_id": 10011,
        "diffrance": 9117,
        "price": 0, // amount paid
        "penalty": 0 //Amount of fine paid
    },
    "meta": {
        "timestamp": "Timestamp" // Timestamp
    }
}

 

پاسخ نادرست – Response False

عنوان	نوع	مقادیر	توضیحات
error
error.code	Integer	شماره خطا مربوطه	جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}

در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نمود اید.