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

موجودیت صورت‌حساب

OpenAPI

صورت‌حساب درخواست پرداخت یک مبلغ ثابت برای یکی از پذیرنده‌های شبکهٔ شماست. دریافت صورت‌حساب و تأیید مصرف این شیء را برمی‌گردانند. مبلغ‌ها رشتهٔ ریالی‌اند و زمان‌ها RFC 3339 به وقت UTC.

The invoice object
{
  "id": "86Rf07xd4z",
  "merchant_id": "khb",
  "external_id": "shop-1",
  "external_order_id": "order-1042",
  "amount": "4900000",
  "status": "paid",
  "payer_mobile": "+989121234567",
  "created_at": "2026-11-07T09:00:00Z",
  "payment_due_at": "2026-11-07T10:00:00Z",
  "paid_at": "2026-11-07T09:05:00Z",
  "consumed_at": null
}

فیلدها

  • idstring

    شناسهٔ صورت‌حساب در رینگ‌پی. کنار سفارش ذخیره کنید.

  • merchant_idstring

    شناسهٔ پذیرنده در رینگ‌پی.

  • external_idstring

    شناسهٔ پذیرنده در سامانهٔ شبکهٔ شما.

  • external_order_idstring

    شناسهٔ سفارشی که موقع ساخت فرستادید.

  • amountstring

    مبلغ به ریال؛ مثلاً "4900000".

  • statusenum

    وضعیت صورت‌حساب. فقط success پرداخت قطعی است.

    • initiated

      ساخته شده و منتظر پرداخت.

    • partially_paid

      بخشی از مبلغ پرداخت شده؛ مشتری می‌تواند باقی را با روش دیگری بپردازد.

    • paid

      مشتری کامل پرداخته و صورت‌حساب منتظر «تأیید مصرف» شماست؛ حداکثر ۳۰ دقیقه پس از paid_at.

    • success

      مصرف تأیید شد؛ تنها وضعیتی که پرداخت قطعی است.

    • canceled

      لغو شده و دیگر پرداخت نمی‌پذیرد.

    • refunding

      برگشت وجه به مشتری در جریان است.

    • partially_refunded

      بخشی از مبلغ به مشتری برگشته.

    • refunded

      کل مبلغ به مشتری برگشته؛ از جمله وقتی paid به‌موقع مصرف نشود.

  • payer_mobilestring

    موبایل پرداخت‌کننده با قالب E.164.

  • created_atstring

    زمان ساخت.

  • payment_due_atstring

    مهلت پرداخت؛ یک ساعت پس از ساخت.

  • paid_atstringممکن است null

    زمان پرداخت کامل؛ تا پیش از آن null.

  • consumed_atstringممکن است null

    زمان «تأیید مصرف»؛ تا پیش از آن null.

صفحه‌ها

endpointها