starcoach-hackathon/zarinpal-analytics-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(api): localize CSV columns in Persian

Browse Source
This commit is contained in:
Amirhossein Khalili
2026-08-20 18:17:19 +03:30
parent 8358cc4d14
commit d133019a14
2 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/openapi.yaml
View File

@@ -453,14 +453,19 @@ paths:
description: |
Uses the same tenant scope, approved period, filters, and allowlisted
projection as `listAnalyticsSessionDetails`. Cursor and page limit do not
apply. Output is UTF-8 with a BOM, an ASCII snake_case header row, comma
separators, CRLF records, and RFC 4180 quoting.
apply. Output is UTF-8 with a BOM, a Persian header row whose labels use
normal spaces, comma separators, CRLF records, and RFC 4180 quoting.
Stable columns are:
`session_id`, `terminal_id`, `session_status`, `amount_rial`,
`fee_amount_rial`, `created_at`, `expires_at`, `attempt_count`,
`latest_attempt_status`, `latest_attempt_at`, `verified_at`, `settled_at`,
`failure_stage`.
`شناسه نشست پرداخت`, `شناسه پایانه`, `وضعیت پرداخت`, `مبلغ ریال`,
`کارمزد ریال`, `زمان ایجاد`, `زمان انقضا`, `تعداد تلاش`,
`وضعیت آخرین تلاش`, `زمان آخرین تلاش`, `زمان تأیید`, `زمان تسویه`,
`مرحله مشاهده شده شکست`.
CSV status labels are Persian: `Paid` is `پرداخت شده و تأیید نشده`,
`Verified` is `تأیید شده`, `Failed` is `ناموفق`, `Reversed` is
`برگشت خورده`, and `InBank` is `در بانک`. Numeric cells remain plain
calculation-safe numbers and timestamps remain UTC ISO values.
Columns unavailable to the chosen authorized view are empty. Payer tokens,
credentials, peer data, internal ids, and any field unavailable in the JSON
@@ -497,7 +502,7 @@ paths:
schema:
type: string
contentMediaType: text/csv
example: "\uFEFFsession_id,terminal_id,session_status,amount_rial,fee_amount_rial,created_at,expires_at,attempt_count,latest_attempt_status,latest_attempt_at,verified_at,settled_at,failure_stage\r\nses_01K2M8,term_0042,Paid,1500000,2000,2026-06-01T08:00:00Z,2026-06-01T08:15:00Z,1,Paid,2026-06-01T08:02:00Z,,,\r\n"
example: "\uFEFF\"شناسه نشست پرداخت\",\"شناسه پایانه\",\"وضعیت پرداخت\",\"مبلغ ریال\",\"کارمزد ریال\",\"زمان ایجاد\",\"زمان انقضا\",\"تعداد تلاش\",\"وضعیت آخرین تلاش\",\"زمان آخرین تلاش\",\"زمان تأیید\",\"زمان تسویه\",\"مرحله مشاهده شده شکست\"\r\nses_01K2M8,term_0042,پرداخت شده و تأیید نشده,1500000,2000,2026-06-01T08:00:00Z,2026-06-01T08:15:00Z,1,پرداخت شده و تأیید نشده,2026-06-01T08:02:00Z,,,\r\n"
'400':
$ref: '#/components/responses/BadRequest'
'401':