تغییرات API

سیاست نسخه‌بندی

• نسخه در مسیر مشخص می‌شود (/api/v1). تغییرات ناسازگار فقط در نسخه جدید منتشر می‌شوند.
• افزودن فیلد جدید به پاسخ، رویداد وب‌هوک جدید یا کد خطای جدید سازگار محسوب می‌شود؛ کلاینت شما باید فیلدهای ناشناخته را نادیده بگیرد.
• کدهای خطا و نام رویدادها هرگز تغییر نام داده نمی‌شوند.
• پیش از حذف هر نسخه، از طریق ایمیل و پنل اطلاع‌رسانی و مهلت مهاجرت اعلام می‌شود.

تاریخچه

به‌روزرسانی v1 — مهر ۱۴۰۵

• استرداد با نتیجه نامشخص بانک پاسخ 202 می‌گیرد و با همان Idempotency-Key تکرارپذیر است.
• پاسخ‌های 409 و 429 دیگر در Idempotency ذخیره نمی‌شوند.
• محدودسازی کلید API به IP یا بازه CIDR هنگام ساخت کلید.
• کنترل دامنه callback_url در حالت آزمایشی هم اعمال می‌شود (localhost فقط در حالت آزمایشی مجاز است).

v1 — ۱۴۰۵/۰۷/۱۱

• ایجاد، استعلام، فهرست، تأیید، برگشت و استرداد پرداخت
• خط زمانی رویدادهای پرداخت
• Idempotency-Key و شناسه درخواست
• وب‌هوک امضاشده برای پرداخت، تسویه، فاکتور، لینک پرداخت و اشتراک