API درگاه › صورتحساب
موجودیت صورتحساب
صورتحساب درخواست پرداخت یک مبلغ ثابت برای یکی از پذیرندههای شبکهٔ شماست. دریافت صورتحساب و تأیید مصرف این شیء را برمیگردانند. مبلغها رشتهٔ ریالیاند و زمانها RFC 3339 به وقت UTC.
{
"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.