پرش به مطلب اصلی

رویداد تغییر تراکنش پرداخت

این سند ساختار رویدادهای تراکنش پرداخت را که می‌توانید از طریق سیستم رویدادها دریافت کنید، توضیح می‌دهد.


توجه کنید که این امکان در لحظه به صورت آزمایشی است و ممکن است در آینده دستخوش تغییر شود..

Transaction​

فیلدنوعتوضیحات
idstringشناسه یکتای تراکنش. این همان UUID است که هنگام ایجاد تراکنش استفاده شده است.
cost_rialsint64هزینه تراکنش به ریال برای برنامه‌ی شما.
extra_detailsstringجزئیات اضافی که در درخواست اصلی تراکنش ارسال شده است.
stateenumوضعیت فعلی تراکنش. برای مقادیر ممکن به وضعیت‌های تراکنش مراجعه کنید.
typeenumنوع تراکنش. برای مقادیر ممکن به انواع تراکنش مراجعه کنید.

Transaction States​

وضعیتمقدارتوضیحات
TRANSACTION_STATE_PENDING1تراکنش در انتظار تکمیل است
TRANSACTION_STATE_COMPLETED2تراکنش با موفقیت انجام شده است
TRANSACTION_STATE_FAILED3تراکنش با شکست مواجه شده است
TRANSACTION_STATE_REFUNDED4تراکنش بازپرداخت شده است

Transaction Types​

نوعمقدارتوضیحات
TRANSACTION_TYPE_REORDER1تراکنش برای بازنشر آگهی

Example Event​

در اینجا یک نمونه از رویداد تراکنش پرداخت آورده شده است:

{
  "type": "PAYMENT_TRANSACTION",
  "payment_transaction": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "cost_rials": 100000,
    "extra_details": "توکن آگهی بازنشر: ABC123",
    "state": "TRANSACTION_STATE_COMPLETED",
    "type": "TRANSACTION_TYPE_REORDER"
  },
  "metadata": {
    "key": "value"
  }
}

Receiving Payment Events​

برای دریافت رویدادهای تراکنش پرداخت، شما باید یک آدرس وب‌هوک معتبر در تنظیمات برنامه‌ی خود پیکربندی کرده باشید. این رویداد بدون نیاز به انجام کار اضافه‌ای هر زمان که تغییری در وضعیت تراکنش رخ دهد، به آدرس وب‌هوک شما ارسال خواهند شد.