کیف پول

هزینهٔ هر رزرو از کیف پول دفتر شما کسر می‌شود. پیش از صدور، موجودی را بخوانید تا مطمئن شوید هزینه را پوشش می‌دهد.

دریافت موجودی#

GET/v3/HAPI/wallet

به اسکوپ wallet:read نیاز دارد. توکن تست موجودی کیف پول سندباکس را گزارش می‌کند و توکن عملیاتی موجودی واقعی دفتر را.

curl https://api.simorghapi.com/v3/HAPI/wallet \
  -H "Authorization: Bearer $ACCESS_TOKEN"

پاسخ#

{
  "object": "wallet",
  "environment": "live",
  "balance":   { "amount": "1240.00", "currency": "USD" },
  "held":      { "amount": "150.00",  "currency": "USD" },
  "available": { "amount": "1090.00", "currency": "USD" }
}

فیلد	توضیح
`balance`	کل موجودی کیف پول.
`held`	مبلغی که برای سفارش‌های نگه‌داشته‌شده اما هنوز صادرنشده بلوکه شده است.
`available`	مبلغی که هنوز می‌توانید خرج کنید: موجودی منهای مبلغ بلوکه‌شده.

بلوکه‌شدن مبلغ و صدور. ایجاد سفارش، مبلغ را از available به held منتقل می‌کند. صدور، آن را از balance کسر می‌کند و لغو، مبلغ بلوکه‌شده را به available برمی‌گرداند. درخواست ایجادی که از available بیشتر شود، خطای 402 insufficient_balance برمی‌گرداند.

ویرایش این صفحه در گیت‌هابمشکلی دیدید؟ از پنل ← پشتیبانی خبرمان کنید.