مستندات اتصال به API
به پورتال توسعهدهندگان یارپرداز خوش آمدید. API ما بر اساس پروتکل REST طراحی شده است و به شما اجازه میدهد فرآیند پرداخت را در هر پلتفرمی (وب، اپلیکیشن موبایل، نرمافزار دسکتاپ) به سادگی پیادهسازی کنید.
v2.4.0 (Stable)
HTTPS Required
ارسال درخواست پرداخت
برای شروع یک تراکنش، باید یک درخواست POST به اندپوینت زیر ارسال کنید.
POST https://api.yarpardaz.ir/v2/payment/request { "api_key": "YOUR_API_KEY", "amount": 500000, "callback_url": "https://mysite.ir/verify", "description": "ساعت مچی X200" }
| پارامتر | نوع | توضیحات |
|---|---|---|
| amount | Integer | مبلغ تراکنش به واحد تومان |
| callback_url | String | آدرس بازگشت پس از پرداخت مشتری |
وبهوکها (Webhooks)
با تنظیم وبهوک، به محض موفقیتآمیز بودن پرداخت مشتری، پلتفرم یارپرداز یک درخواست به صورت Real-time به سرور شما ارسال میکند تا فاکتور را به صورت خودکار تایید کنید.