ساخت پرداخت

حرفه‌ایکلید خواندن و نوشتن

در پلن حرفه‌ای و سازمانی در دسترس است (بتا).

POST…/public/payments

یک پرداخت تازه در کسب‌وکار صاحب کلید می‌سازد. پاسخ همان رکورد است.

درخواست
curl https://app.reshta.ir/api/v1/public/payments \​  -X POST \​  -H "Authorization: Bearer $RESHTA_API_KEY" \​  -H "Idempotency-Key: 7f3c2b1e-4a5d-4c6f-9e1a-2b3c4d5e6f70" \​  -H "Content-Type: application/json" \​  -d '{"amount":1,"currency":"IRR","deal_id":"0192c4e8-7b1a-7c3e-9f20-5d6a1b2c3d4e"}'​

سرآیندها

AuthorizationstringالزامیBearer و کلید API کسب‌وکار (rk_live_…).
Idempotency-Keystringالزامیشناسهٔ یکتای همین عملیات، مثلاً یک UUID تازه؛ تکرار با همان کلید چیزی را دوبار انجام نمی‌دهد.
Content-Typeapplication/jsonالزامیبدنه JSON با UTF-8 است.

پارامترهای بدنه

amountintegerالزامی
currencystringالزامیواحد پول، مثلاً IRR.مقدارها:IRR
deal_iduuidالزامیمعاملهٔ مرتبط.
paid_atstringاختیاری
notestringاختیاری

پاسخ‌ها و خطاها

201—ساخته شد؛ بدنه همان رکورد است.
400validation_errorبدنه نادرست است یا Idempotency-Key نیامده؛ details می‌گوید کدام فیلد.
401unauthorizedکلید نیست، نادرست یا باطل است، یا سازنده‌اش دیگر فعال نیست.
403forbiddenکلید دسترسی نوشتن ندارد.
409conflictهمین Idempotency-Key با بدنهٔ دیگری آمده یا هنوز در جریان است.
429rate_limitedبیش از ۱۲۰ درخواست در دقیقه؛ Retry-After می‌گوید چند ثانیه صبر کنید.
پاسخ
400
{​  "error": {​    "code": "validation_error",​    "message": "Idempotency-Key header is required",​    "details": [​      {​        "field": "idempotency_key",​        "message": "idempotency_key_required"​      }​    ]​  }​}​

کلید API بسازید و اولین درخواست را بفرستید

کلید در اپ رشتا ساخته می‌شود و فقط یک بار نشان داده می‌شود. API و وب‌هوک (بتا) در پلن حرفه‌ای و سازمانی است و کلید را فقط مدیر کسب‌وکار می‌سازد.

  1. ۱ورود به app.reshta.ir
  2. ۲اتصال ← توسعه‌دهنده
  3. ۳ساخت کلید API