💳API فاکتور ایجاد کنید
The Create Invoice API allows you to generate an invoice for a specific merchant. This API handles parameters like the merchant's information, reference ID, currency, and amount to create an invoice for a given transaction.
توجه:
اطمینان حاصل کنید که یک معتبر را پاس کرده ایدmerchant_id, reference_id، ومقدارهنگام درخواست اگر تاجر یا مرجع پیدا نشد یا مبلغ نامعتبر باشد، خطا برگردانده می شود.
📝 پارامترهای ورودی
| پارامتر | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| merchant_id | string | ✔️ | شناسه منحصر به فرد برای تاجر. این برای ایجاد فاکتور لازم است. |
| reference_id | string | ✔️ | The `reference_id` is a unique string used to track the user's order in the issuer's database. It can be the order ID from the issuer's database table. |
| currency_id | string | ✔️ | UUID of the enabled currency configured in the gateway. |
| مقدار | string | ✔️ | The transaction amount. Must be a valid string representation of the amount (e.g., "10.50"). |
| توضیحات | string | ❌ | شرح اختیاری برای فاکتور (به عنوان مثال، برای هدف معامله). |
- 🔹 API به یک نیاز داردکلید APIبرای احراز هویت
- 🔹 راmerchant_idباید در بدنه درخواست تصویب شود.
- 🔹 رامقدارباید یک نمایش رشته معتبر از یک عدد و بزرگتر از 1 باشد.
💡 درخواست نمونه
POST https://core.dinakel.com/api/gateway/v1/invoices
Headers:
Authorization: Bearer <your_api_key>
Body:
{
"merchant_id": "<merchant_id>",
"reference_id": "<reference_id>",
"currency_id": "<currency_id>",
"amount": "<amount>",
"description": "<description>"
}
🔍 نمونه پاسخ
{
"status": true,
"statusCode": 201,
"invoice_id": "<invoice_id>",
"data": {
"invoice_id": "<invoice_id>"
}
}
⚠️ رسیدگی به خطاها
API پاسخ های خطای زیر را ارائه می دهد:
{
"status": false,
"statusCode": 400,
"message": "Amount must be a valid decimal number."
}
400 Bad Request:پارامتر مقدار نامعتبر است. مطمئن شوید که مقدار یک عدد اعشاری معتبر و بزرگتر از 1 باشد.
{
"status": false,
"statusCode": 404,
"message": "Merchant or reference not found"
}
404 Not Found:شناسه تجاری یا مرجع ارائه شده در سیستم وجود ندارد. شناسه و مرجع تاجر را دوباره بررسی کنید.
{
"status": false,
"statusCode": 500,
"message": "Internal server error"
}
500 Internal Server Error:یک خطای غیرمنتظره در سرور رخ داد. بعداً دوباره امتحان کنید یا با پشتیبانی تماس بگیرید.