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

# استرداد وجه

به کمک سرویس استرداد وجه (ریفاند) زرین‌پال، در صورت تغییر یا لغو سفارش مشتریان، واریزی‌های اشتباه یا هرگونه الزامی جهت بازگرداندن وجه به خریدار، تمام مبلغ واریز شده یا حتی بخشی از آن را به صورت آنی و خودکار، به حساب آن‌ها واریز نمایید.

کالکشن پست من (opens new window)

# شماره تراکنش

برای استفاده از این سرویس، نیاز به اطلاعاتی شامل شماره تراکنش مورد نظر و مبلغ آن است که در قسمت تراکنش‌ها قابل مشاهده است.

# ثبت درخواست

پس از به دست آوردن شماره تراکنش و مبلغ آن برای ثبت درخواست استرداد وجه از درخواست زیر استفاده کنید:

پارامتر های مورد نیاز

  • session_id شماره تراکنش

  • amount مبلغ ریال (حداقل مبلغ قابل استرداد ۲۰۰۰۰ ریال)

  • description توضیح علت استرداد وجه

  • reason دلیل استرداد

    • CUSTOMER_REQUEST درخواست خریدار

    • DUPLICATE_TRANSACTION تراکنش تکراری

    • SUSPICIOUS_TRANSACTION تراکنش مشکوک

    • OTHER سایر

شما می‌توانید در محیط اجرای GraphiQL (opens new window) پرس‌و‌جوهای فوق را تست کنید.


mutation AddRefund($session_id: ID!, $amount: BigInteger!, $description: String, $reason: RefundReasonEnum) {
  resource: AddRefund(session_id: $session_id, amount: $amount, description: $description, reason: $reason) {
terminal_id
id
amount
  timeline {
      refund_amount
      refund_time
      refund_status
    }
  }
}

Query Variables

{
  "session_id": "385404539",
  "amount": 11000,
  "description": "تست سرویس",
  "reason": "CUSTOMER_REQUEST"
}

# پاسخ دریافتی

در پاسخ درخواست استرداد وجه ثبت شده، از سمت زرین‌پال پاسخ روبرو شامل: شماره تراکنش، مبلغ، شماره ترمینال، تاریخچه پرداخت و بازگشت را دریافت می‌کنید.

  • id شماره تراکنش

  • amount مبلغ پرداخت شده به ریال

  • terminal اطلاعات ترمینال درگاه

  • timeline تاریخچه تراکنش

    • refund_amount مبلغ استرداد

    • refund_time تاریخ ثبت استرداد

    • refund_status وضعیت استرداد


{
  "data": {
    "resource": {
      "terminal_id": "238",
      "id": "386426364",
      "amount": 20000,
      "timeline": {
        "refund_amount": 20000,
        "refund_time": "2022-11-02T15:15:37+03:30",
        "refund_status": "PENDING"
      }
    }
  }
}