برگشت (reverse)

لغو پرداخت پیش از تسویه.

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

POST/api/v1/payments/{id}/reverse

پارامترها

نام	نوع	توضیح
`reason`	string ≤ 255	دلیل (اختیاری).

bash

curl -X POST https://api.sheypay.ir/api/v1/payments/PAYMENT_ID/reverse \
  -H "Authorization: Bearer sk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "کالا موجود نبود" }'

فقط برای پرداخت‌های successful یا verified که وارد تسویه نشده‌اند ممکن است؛ پس از آن از استرداد استفاده کنید.
برخلاف استرداد، در برگشت کارمزد هم برگردانده می‌شود.
تکرار درخواست بی‌خطر است؛ پرداختی که قبلاً برگشت خورده با همان وضعیت reversed برمی‌گردد.
اگر پاسخ بانک نامشخص باشد، 504 provider_timeout برمی‌گردد و برگشت به‌صورت خودکار پیگیری می‌شود.