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

# تسویه حساب

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

# لیست تسویه حساب

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

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

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

  • filter فیلتر وضعیت تسویه حساب ها

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

id : شناسه تسویه در زرین پال

status : وضعیت تسویه حساب

amount : مبلغ تسویه شده

payable_at : تاریخ ایجاد

reference_id : شناسه ارجاع بانکی

reconciled_at : تاریخ واریز شده


query getReconciles
 		($terminal_id: ID,
 	     $filter: ReconciliationStatusEnum,
         $id: ID, $reference_id: String){
          resource: Reconciliation(
            terminal_id: $terminal_id,
            filter: $filter, id: $id,
            reference_id: $reference_id) {
    id
    status
    amount
    payable_at
    reference_id
    reconciled_at
  }
}

Query Variables

{
  "terminal_id": "337759",
  "filter": "ALL"
}

پاسخ دریافتی

{
  "data": {
    "resource": [
      {
        "id": "8039236",
        "status": "PAID",
        "amount": 28000000,
        "payable_at": "2023-09-12T00:20:43+03:30",
        "reference_id": "1402,06,21N1000000000000337759",
        "reconciled_at": "2023-09-12T17:00:00+03:30"
      },
      {
        "id": "7915681",
        "status": "PAID",
        "amount": 169840000,
        "payable_at": "2023-08-29T00:25:30+03:30",
        "reference_id": "1402,06,07N1000000000000337759",
        "reconciled_at": "2023-08-29T17:00:00+03:30"
      }
    ]
  }
}

# فیلتر تسویه ها

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

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

ALL : همه تسویه حساب ها

PAID : به صورت کامل تسویه شده است

IN_PROGRESS : ارسال شده به سمت شاپرک

REVERSED : تسویه حساب بازگردانی شده

مورد دیگری که در فیلتر ها میتوان لحاظ کرد فیلتر بر اساس تاریخ تسویه حساب ها هست

created_from_date : از تاریخ مد نظر ( فرمت تاریخ دهی به صورت سال - ماه - روز)

created_to_date : ( فرمت تاریخ دهی به صورت سال - ماه - روز) تا تاریخ


query getReconciles
 		($terminal_id: ID,
 	     $filter: ReconciliationStatusEnum,
      $created_from_date: DateTime, $created_to_date: DateTime,
         $id: ID, $reference_id: String){
          resource: Reconciliation(
            terminal_id: $terminal_id,
            filter: $filter, id: $id,
            created_to_date: $created_to_date, created_from_date: $created_from_date
            reference_id: $reference_id) {
    id
    status
    amount
    payable_at
    reference_id
    reconciled_at
  }
}

Query Variables

{
  "filter": "PAID",
  "terminal_id": "337759",
  "created_from_date": "2023-08-18",
  "created_to_date": "2023-09-18"
}

پاسخ دریافتی

{
  "data": {
    "resource": [
      {
        "id": "8039236",
        "status": "PAID",
        "amount": 28000000,
        "payable_at": "2023-09-12T00:20:43+03:30",
        "reference_id": "1402,06,21N1000000000000337759",
        "reconciled_at": "2023-09-12T17:00:00+03:30"
      },
      {
        "id": "7915681",
        "status": "PAID",
        "amount": 169840000,
        "payable_at": "2023-08-29T00:25:30+03:30",
        "reference_id": "1402,06,07N1000000000000337759",
        "reconciled_at": "2023-08-29T17:00:00+03:30"
      },
      {
        "id": "7894067",
        "status": "PAID",
        "amount": 52500000,
        "payable_at": "2023-08-27T00:19:09+03:30",
        "reference_id": "1402,06,05N1000000000000337759",
        "reconciled_at": "2023-08-27T17:00:00+03:30"
      }
    ]
  }
}