‏API درگاه › صورت‌حساب

دریافت صورت‌حساب

OpenAPI
GET/gateway-api/v1/invoices/{invoice_id}

صورت‌حساب را در هر وضعیتی برمی‌گرداند؛ برای بررسی بعد از بازگشت مشتری، تطبیق حساب و پشتیبانی. چیزی را تغییر نمی‌دهد و جای تأیید مصرف را نمی‌گیرد.

GET /gateway-api/v1/invoices/{invoice_id}
curl "$RINGPAY_BASE_URL/gateway-api/v1/invoices/86Rf07xd4z" \
  -H "Authorization: Bearer $RINGPAY_API_KEY"
Response 200
{
  "amount": "4900000",
  "consumed_at": null,
  "created_at": "2026-11-07T09:00:00Z",
  "external_id": "shop-1",
  "external_order_id": "order-1042",
  "id": "86Rf07xd4z",
  "merchant_id": "khb",
  "paid_at": "2026-11-07T09:05:00Z",
  "payer_mobile": "+989121234567",
  "payment_due_at": "2026-11-07T10:00:00Z",
  "status": "paid"
}

پارامترها

  • invoice_idstringالزامی

    شناسهٔ صورت‌حساب که موقع ساخت گرفتید. آن را از سفارش ذخیره‌شده بخوانید، نه از پارامترهای بازگشت مشتری.

پاسخ

موجودیت صورت‌حساب. paid یعنی مشتری کامل پرداخته و صورت‌حساب منتظر تأیید مصرف است. صورت‌حساب پذیرندهٔ شبکهٔ دیگر، صورت‌حساب حضوری یا شناسهٔ ناشناخته 404 invoice_not_found می‌گیرد.

خطاها

کدهای مشترک و رفتار هر کد در خطاها آمده.

  • invalid_access_key401

    کلید فرستاده نشده، نامعتبر است، منقضی شده یا باطل شده.

  • access_denied403

    کلید دسترسی این API را ندارد (gateway_access برای درگاه، merchant_access برای پذیرنده‌ها)، یا درخواست از IPی بیرون از فهرست مجاز کلید آمده.

  • invoice_not_found404

    صورت‌حساب نیست، مال پذیرندهٔ شبکهٔ دیگری است یا صورت‌حساب حضوری است.

  • internal_error500

    خطای رینگ‌پی. کمی بعد همان درخواست را تکرار کنید.

صفحه‌ها

endpointها