update payment ticket docs (#117)

Co-authored-by: Mobin Pourabedini <[email protected]>
divar-ir · Jan 11, 2025 · 8c49775 · 8c49775
1 parent c237d2a
commit 8c49775
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 12 deletions.
diff --git a/payment-ticket/generate.md b/payment-ticket/generate.md
@@ -10,17 +10,39 @@
 در مسیج ListPostServiceProvidersRequest یک فیلد آپشنال به نام `ticket_uuid` قرار دارد که میتوان این فیلد را با مقدار تیکت ساخته شده از اندپوینت قبلی ، پر کرد. با پر کردن این فیلد ، سرویس پروایدر خارجی از نمایش درگاه پرداخت به کاربر جلوگیری میکند و در هنگام ساخت افزونه ی کاربر ،‌این تیکت باطل میشود.
 
 ### ریکوئست
-
+```go
 metadata = (('x-app-slug', 'test'),('x-api-key-id', '110'))
-req = GenerateRequest(phone_number='09990000000', service_type=ServiceType.REPORT_VERIFICATION, max_amount_sponsored=10000)
+```
+
+```go
+req := &pb.GenerateRequest{
+    DivarUserId: "sample_divar_user_id",
+    ServiceType: pb.ServiceType_REPORT_VERIFICATION,
+    MaxAmountSponsored: 10000,
+}
+
+// or the deprecated version
+req := &pb.GenerateRequest{
+    Phone: "09990000000", // deprecated
+    ServiceType: pb.ServiceType_REPORT_VERIFICATION,
+    MaxAmountSponsored: 10000,
+}
+```
+```go
 stub.Generate(request=req)
+```
 
-- فیلد x-api-ket-id برابر با آیدی api key است که با پرمیشن ساخت بلیط ساخته شده است.
-- فیلد x-app-slug برابر با slug اپ ساخته شده در پنل کناز است.
-- فیلد phone_number باید با شماره کاربری که میخواهیم احراز رایگان را انجام دهد پر شود. 
-- فیلد service_type برابر با نوع سرویس مورد استفاده است. برای سرویس احراز این مقدار برابر با `REPORT_VERIFICATION` می‌باشد.
-- فیلد max_amount_sponsored برابر با حداکثر مقدار مدنظر برای هزینه ی احراز به ریال است. 
+- فیلد `x-api-ket-id` برابر با آیدی `api key` است که با پرمیشن ساخت بلیط ساخته شده است.
+- فیلد `x-app-slug` برابر با `slug` اپ ساخته شده در پنل کناز است.
+- فیلد `phone_number` می‌تواند با شماره کاربری که میخواهیم احراز رایگان را انجام دهد پر شود یا در صورت استفاده از 
+  `divar_user_id` خالی باشد. 
+- فیلد `divar_user_id` برابر با شناسه کاربر در دیوار است.
+- فیلد `service_type` برابر با نوع سرویس مورد استفاده است. برای سرویس احراز این مقدار برابر با `REPORT_VERIFICATION` می‌باشد.
+- فیلد `max_amount_sponsored` برابر با حداکثر مقدار مدنظر برای هزینه ی احراز به ریال است. 
 
 ### ریسپانس
-
-ticket_uuid: "4ddaff7e-275a-4928-9d4a-25765114fa3b"
+```json
+{
+    "ticket_uuid": "4ddaff7e-275a-4928-9d4a-25765114fa3b"
+}
+```
diff --git a/payment-ticket/validate.md b/payment-ticket/validate.md
@@ -11,12 +11,15 @@ x-api-key: {{apikey}}
 
 {
     "ticket_uuid": "6ca5ba03-f3a1-4761-9c60-8760f442a352", 
-    "phone_number": "099800000", 
+    "user_id": "sample_divar_user_id",
+    "phone_number": "099800000",  // not required if user_id is provided
     "service_cost": 104000
 }
 ```
-- تمامی فیلد ها اجباری هستند
-- برای به دست آوردن شماره تلفن کاربری که تیکت را استفاده میکند، نیاز است در فرایند oauth شماره کاربر را در scope ها قرار داده شود. بنابراین پیش از oauth فراخوانی این اندپوینت امکان پذیر نیست. 
+-   حداقل یکی از فیلد های `user_id` یا `phone_number` باید پر شود.
+-   فیلد‌های `service_cost` و `ticket_uuid` اجباری هستند.
+-  گرفتن oauth شماره کاربر به منظور چک کردن تیکت پشنهاد نمی‌شود زیرا می‌توانید از `user_id` استفاده کنید که سبب بالا 
+   رفتن conversion rate می‌شود.(برای به دست آوردن هر کدام از این دو مورد باید از oauth استفاده کنید)
 - فیلد service_cost برابر با قیمت سرویس خود سرویس پروایدر به ریال است. 
 
 ### ریسپانس