Developer Documentation

API یکپارچه PayPardakht

با Sandbox شروع کنید، سپس بدون تغییر Contract به کلید Live مهاجرت کنید.

احراز API

کلید را در Bearer Token بفرستید. کلید Sandbox با pp_test_ و کلید Live با pp_live_ شروع می‌شود.

Authorization: Bearer pp_test_xxxxxxxxxxxxx

Sandbox در برابر Live

Sandbox

بدون کسر موجودی و بدون تماس با Provider واقعی؛ مناسب توسعه و CI.

Live

از کیف پول کسر می‌کند و Provider واقعی سرویس را اجرا می‌کند.

ایجاد استعلام

curl -X POST 'https://paypardakht.ir/api/v1/inquiries/mobile-national-id-match' \
  -H 'Authorization: Bearer pp_test_xxx' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: signup-user-123' \
  -d '{"national_id":"0012345679","mobile":"09121234567"}'

پاسخ اولیه معمولاً HTTP 202 است و tracking_code برمی‌گرداند.

دریافت وضعیت

GET https://paypardakht.ir/api/v1/inquiries/PP-XXXX

تا تکمیل پردازش می‌توانید Poll کنید یا نتیجه نهایی را از Webhook دریافت کنید.

Idempotency

برای عملیات مالی همیشه Idempotency-Key بفرستید. تکرار همان کلید با همان Payload هزینه جدید ایجاد نمی‌کند؛ استفاده همان کلید با Payload متفاوت HTTP 409 می‌دهد.

Webhook

امضای درخواست با HMAC-SHA256 روی timestamp.body ساخته می‌شود و در X-PayPardakht-Signature ارسال می‌شود.

سرویس‌های فعال API

0 سرویس

پروندهٔ احراز هویت

با POST /api/v1/identity-cases و یک client_reference فنی پرونده بسازید.
سرویس next_service را با کلید همان پروژه ثبت کنید و tracking_code را به POST /api/v1/identity-cases/{case}/inquiries بفرستید.
با GET /api/v1/identity-cases/{case} وضعیت، دلیل توقف، تاریخچه و هزینه را دریافت کنید. برای هر استعلام جدید از کلید تکرار مستقل استفاده کنید.

شناسهٔ فنی پرونده و داده‌های ساختگی را در Sandbox استفاده کنید. برای آزمون عدم تطبیق شاهکار از شمارهٔ نمونهٔ 09123456780 استفاده کنید.