رفتن به محتوای اصلی

مشتریان

پرداخت‌کننده‌هایتان را یک جا نگه دارید، با کارت‌هایشان، جمع پرداخت‌ها و اعتباری که به آن‌ها بدهکارید.

مشتری پرداخت‌های یک نفر را کنار هم می‌گذارد: نام، شمارهٔ موبایل و ایمیل، چهار رقم آخر کارت‌هایی که از آن‌ها پرداخت کرده، تعداد و جمع پرداخت‌های موفق و هر اعتباری از بیش‌واریزی که برایش نگه داشته‌اید.

مشتری‌ها از کجا می‌آیند

  • خودتان می‌سازیدشان، در داشبورد از بخش مشتریان یا با POST /v1/customers.
  • پرداختی که با customer_details ساخته شده و موفق می‌شود، مشتری با همان شمارهٔ موبایل را پیدا می‌کند یا یکی می‌سازد.
  • پرداختی که با customer: "cus_…" ساخته شود از اول مال همان مشتری است.

شمارهٔ موبایل میان مشتری‌های یک حالت یکتاست: ساختن مشتری دوم با همان شماره با customer_phone_taken رد می‌شود. شماره‌ها به هر شکلی تایپ شوند، به صورت 09xxxxxxxxx ذخیره می‌شوند.

curl https://a.bezanbecard.com/v1/customers \
  -H "Authorization: Bearer sk_test_…" \
  -H "Idempotency-Key: customer-09900001234" \
  -H "Content-Type: application/json" \
  -d '{"name":"Test Customer","phone":"09900001234","email":"[email protected]"}'

پیدا کردن مشتری

GET /v1/customers مشتری‌ها را از جدید به قدیم فهرست می‌کند و بر اساس phone (به هر شکلی که تایپ شود) و email فیلتر می‌شود. GET /v1/customers/:id یک مشتری را و GET /v1/payments?customer=cus_… پرداخت‌هایش را برمی‌گرداند.

اعتبار

credit مبلغی به ریال است که از بیش‌واریزهای بسته‌شده با credited برای مشتری نگه داشته‌اید (بیش‌واریز را ببینید). این یک سابقه است، نه موجودی‌ای که بزن به کارت خرجش کند: در سفارش بعدی به روش خودتان رعایتش کنید.

ویرایش و حذف

POST /v1/customers/:id فیلدهای name، phone، email و metadata را تغییر می‌دهد. DELETE /v1/customers/:id مشتری را حذف می‌کند و { "id": "cus_…", "object": "customer", "deleted": true } برمی‌گرداند؛ تا وقتی یکی از پرداخت‌هایش هنوز باز است، با customer_payments_open رد می‌شود. پرداخت‌های تمام‌شده نسخهٔ خودشان از مشخصات مشتری را نگه می‌دارند.

تغییرها رویدادهای customer.created، customer.updated و customer.deleted را می‌سازند.