خانه درگاه پرداخت مستندات API راهنمای استفاده افزونه‌ها

# تراکنش ها

در این بخش به قسمت تراکنش ها و فیلتر کردن آن ها و اطلاعاتی که میتوان دریافت کرد میپردازیم

# لیست تراکنش ها

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

در این درخواست پارامتر ورودی شماره ترمینال اجباری میباشد

  • terminal_id شماره ترمینال درگاه مورد نظر

  • id شناسه پرداخت

  • status وضعیت تراکنش

  • amount مبلغ (به ریال)

  • description توضیحات

  • created_at تاریخ و ساعت


query {Session (terminal_id:238){
id
status
amount
description
created_at
}
}

پاسخ دریافتی

{
  "data": {
    "Session": [
      {
        "id": "388171285",
        "status": "FAILED",
        "amount": 815000,
        "description": "خرید تست",
        "created_at": "2022-11-11T09:36:40+03:30"
      }
    ]
  }
}

# فیلتر تراکنش ها

همانطور که گفته شد برای بخش تراکنش ها فیلتر های مختلفی میتوان لحاظ کرد که به آن ها میپردازیم

اولین مورد فیلتر بر اساس وضعیت تراکنش ها هست - این فیلتر دارای یکی از مقدار های ذکر شده میتواند باشد

PAID : تراکنش های موفق عدم اعتبار سنجی

VERIFIED : تراکنش های موفق اعتبار سنجی شده

TRASH : تراکنش های ناموفق

ACTIVE : همه تراکنش های موفق

REFUNDED : تراکنش های استرداد شده

 query {Session (terminal_id:174985,filter:PAID){
   session_tries {
     id
     session_id
     payment_id
     payer_ip
     init_time
     verify_time
     status
     rrn
     card_pan
     created_at
   }
   description
   amount
   fee
 }
 }

در پاسخ به این درخواست، پاسخی به این شکل دریافت می‌شود :

{
  "data": {
    "Session": [
      {
        "session_tries": [
          {
            "id": "1",
            "session_id": "423527591",
            "payment_id": "46",
            "payer_ip": "158.255.77.66",
            "init_time": 58,
            "verify_time": 101,
            "status": "PAID",
            "rrn": "21902403390",
            "card_pan": "502229******8920",
            "created_at": "2023-04-15T19:14:28+03:30"
          }
        ],
        "description": "افزایش اعتبار کاربر شماره",
        "amount": 11275,
        "fee": 275
      }
    ]
  }
}

# جستجو در تراکنش ها

برای جستجو در تراکنش ها پارامتر های مختلفی در نظر گرفته شده که در این درخواست با آن ها آشنا میشویم

پارامتر هایی که برای جستجو میتوانیم استفاده کنیم این موارد هستند

  • id شناسه پرداخت

  • reference_id شناسه ارجاع

  • rrn شماره ارجاع بانکی

  • card_pan شماره کارت یا بخشی از شماره کارت بانکی

  • email ایمیل

  • mobile شماره همراه

  • description توضیحات تراکنش

یک نمونه درخواست جستجو تراکنشی خاص

query Sessions($terminal_id: ID, $reference_id: String,$id: ID, $card_pan: String,
$description: String, $mobile: CellNumber, $email: String, $rrn: String) {
Session(terminal_id: $terminal_id, reference_id: $reference_id, id: $id,card_pan: $card_pan,
description: $description, mobile: $mobile, email: $email, rrn: $rrn) {
id
status
amount
description
created_at
}
}

Query Variables

{
  "card_pan": "8920",
  "rrn": "141186863321",
  "reference_id": "38540453901",
  "terminal_id": "337759",
  "id": "385404539",
  "mobile": "09121234567"
}

پاسخ دریافتی

{
  "data": {
    "Session": [
      {
        "id": "385404539",
        "status": "PAID",
        "amount": 11000,
        "description": "پرداخت کننده: Teststts\nتوضیحات: Shshdjdjd",
        "created_at": "2022-10-28T13:19:05+03:30"
      }
    ]
  }
}