آخرین تغییرات: 1400/08/01
بازگشت وجه
برای بازگرداندن مبلغ یک تراکنشِ موفقِ درگاه پرداخت، به شماره کارت پرداختکننده میتوان از ابزار بازگشت وجه استفاده کرد.
شرایط لازم برای بازگشت وجه:
- فعال بودن ابزار بازگشت وجه
- موفق بودن تراکنش
- داشتن موجودی کافی در کیفپول
ثبت درخواست بازگشت وجه:
برای ثبت درخواست بازگشت وجه یک تراکنش موفق کافیست نشانی زیر را صدا بزنید:
METHOD: POST URL: https://api.vandar.io/v3/business/{businessName}/transaction/{transaction_id}/refund Header:
Authorization : Bearer {token}
Accept : application/json
Content-Type : application/json
در این نشانی:
- businessName نام انگلیسی کسبوکار است که در هنگام ثبت کسبوکار به وندار ارائه شده.
- transaction_id شناسهی یکتای تراکنش در وندار است.
پارامترهای مجاز
Name | Type | Status |
---|---|---|
payment_number | string | optional |
amount | string | optional |
description | string | optional |
notify_url | url | optional |
توضیحات
- payment_number باید برای هر درخواست مقداری یکتا باشد.
- amount در صورت ارسال، این مقدار از کل مبلغ تراکنش برگردانده می شود.
- description محل درج توضیحات است.
- notify_url بعد از مشخص شدن وضعیت بازگشت وجه این آدرس صدا زده میشود.
نمونه json
{ "payment_number": "13456", "amount": "500000", "description": "160969188194 بازگشت وجه تراکنش " }
نمونه پاسخ دریافتی موفق
HTTP/1.1 200 { "status": 1, "data": { "message": " عملیات بازگشت وجه با موفقیت ثبت گردید. ", "results": [ { "id": "e2ee0fb0-c070-11eb-8d4b-f782f5608cc2", "retry_count": "01", "gateway_transaction_id": 162203075684, "amount": "1500000000", "wage": 1000, "payment_number": null, "status": "PENDING", "description": "160969188194 بازگشت وجه تراکنش", "wallet": "99999889000", "refund_date": "1400/03/08 15:57:43", "created_at": "1400/03/08 15:57:44" }, { "id": "e2ee0fb0-c070-11eb-8d4b-f782f5608cc3", "retry_count": "01", "gateway_transaction_id": 162203075685, "amount": "500000000", "wage": 1000, "payment_number": null, "status": "PENDING", "description": "160969188194 بازگشت وجه تراکنش", "wallet": "99999889000", "refund_date": "1400/03/08 15:57:43", "created_at": "1400/03/08 15:57:44" }, ] }, }
توضیحات
- results آرایه ای از تراکنش های بازگشتی است. به ازای هر ۱۵ میلیون تومان از مبلغ بازگشت وجه یک تراکنش ایجاد می شود.
- Gateway_transaction_id شناسه تراکنش عملیات بازگشت وجه است.
- Amount مبلغ بازگردانده شده به ریال
- Wage کارمزد بازگشت وجه به ریال
- Status وضعیت تراکنش است که در زمان ثبت به صورت PENDING نمایش داده میشود.
- Wallet موجودی کیفپول پس از بازگشت وجه به ریال
- refund_date تاریخ و زمان انجام عملیات بازگشت وجه. این نخستین زمانی است که مبلغ قابل برداشت کیفپول برای انجام تراکنش بازگشت وجه کافی باشد (متناسب با زمان بروزرسانی مبلغ قابل برداشت کیفپول). در این زمان درخواست بازگشت وجه به بانک ارسال میشود.
نمونه پاسخ دریافتی ناموفق
HTTP/1.1 401 { "status": 0, "error": "Unauthenticated" }
توضیحات
- status: درصورت ناموفق بودن درخواست این مقدار برابر با 0 می باشد
- error: در صورت منقضی شدن Token ارسالی در Header و یا اشتباه بودن Token با مقدار Unauthenticated برگشت داده میشود.
نکته!
در صورتی که مقدار پارامتر notify_url تکمیل شود، پس از انجام تراکنش تسویه، وبهوکی با فرمت زیر به آدرس ثبت شده ارسال خواهد شد اطلاعات وبهوک به شکل form_data ارسال می شوند.
در صورتی که مقدار پارامتر notify_url تکمیل شود، پس از انجام تراکنش تسویه، وبهوکی با فرمت زیر به آدرس ثبت شده ارسال خواهد شد اطلاعات وبهوک به شکل form_data ارسال می شوند.
HTTP/1.1 200
{
"id": "865e9d07-2c96-41ef-8f61-30de27fb9954"
"iban_id": "72a8aab1-04c9-417e-9971-2f7bfe121b53"
"transaction_id": "164258101221"
"amount": "2500000"
"payment_number": "123456"
"status": "DONE"
"settlement_date": "2022-01-19"
"settlement_date_jalali": "1400/10/29"
"revised_transaction_id": ""
"ref_code": "140010290622047785"
}
- id: شناسه یکتای تسویه
- iban_id: شناسه یکتای شماره شبا
- transaction_id:شناسه یکتای تراکنش در وندار
- amount: مبلغ تسویه به ریال
- payment_number: شناسه پرداخت
- status: وضعیت تسویه
- settlement_date: تاریخ انجام تسویه (میلادی)
- settlement_date_jalali:تاریخ انجام تسویه (شمسی)
- revised_transaction_id: شناسه یکتای تراکنش اصلاحی برای تسویه های کنسل شده
- ref_code: (یا همان کد RRN) شناسه یکتای مرجع تسویه انجام شده برای تسویه های موفق